Create Multilingual Project

post https://api.textunited.com/segments/projects

This endpoint initializes a new multilingual project in TextUnited. For a detailed guide on initializing your project, including how to configure it according to your needs, refer to the Project Initialization guide.

ℹ️
Instructions
Ensure that your request includes the necessary headers. To test the request directly on the platform:

Navigate to the HEADERS section below the Request Body section.

Enter the "Content-Type" header with the value "application/json."

Include your "Authorization" token using either Basic Auth or JWT Access Token (for detailed instructions on obtaining these tokens, see the documentation on Obtaining your API key and company ID and Obtaining your JWT token).

Enter the values for the fields in your Request Body section below.

Click the "Try It!" button at the top-right of your screen to initiate the request and view your response.

❗️
Sample Request and Response
To see a sample request and response, click the "EXAMPLES" dropdown at the top-right of your screen.

🚧
Note
The targetLanguages and segments arrays in the Request Body include sub-objects with specific properties. Please review these details carefully when preparing your API requests.

Request Body

The request should include the following parameters. Enter your values in the input field(s) below for testing:

Body Params

customId

string

A unique identifier for the project. Optional.

taskId

string

An identifier for the task associated with the project. Optional. Refer to the documentation to learn more about taskId and its impact on segment processing and update scope.

name

string

required

The name of the project.

description

string

A description of the project. Optional.

startDateUtc

string

required

The start date and time of the project in UTC timezone. (Must be in the present.)

endDateUtc

string

required

The end date and time of the project in UTC timezone.

sourceLanguageId

int64

The ID of the source language. Optional if the sourceLanguageCode is defined.

sourceLanguageCode

string

The code of the source language. Optional if the sourceLanguageId is defined.

targetLanguages

array of objects

required

An array of objects representing the target languages for translation.

targetLanguages*

segments

array of objects

required

An array of objects representing individual segments of content to be translated.

segments*

referenceNumber

string

A reference number for the project. Optional.

customField1

string

Additional information identifying the project in an external system. Optional.

customField2

string

Additional information identifying the project in an external system. Optional.

Headers

Content-Type

string

Defaults to application/json

Indicates the media type of the resource, specifying that the payload is in JSON format. (e.g. Content-Type: application/json)

Authorization

string

Used for authenticating requests with a JWT token obtained from the "Obtain JWT" endpoint. (e.g. Authorization: Bearer <your_api_token>)

Responses

Create Multilingual Project

ℹ️
Instructions

❗️
Sample Request and Response

🚧
Note

Request Body

ℹ️Instructions

❗️Sample Request and Response

🚧Note

Request Body

200200

400400

ℹ️
Instructions

❗️
Sample Request and Response

🚧
Note