Text translations v2 - Phrase Developer Hub

Authorizations

Authorization

string

header

required

Provide Authorization header with token obtained through Login operation.

Body

application/json

sourceTexts

object[]

required

Required array length: 1 - 6 elements

Show child attributes

sourceTexts.key

string

required

The key of the source text. This is used to identify the source text in the response. Must be unique.

Required string length: 1 - 50

sourceTexts.source

string

required

The source text to be translated.

Required string length: 1 - 2000

targetLang

object

required

Show child attributes

targetLang.code

string

required

Language code, using a two-letter language code from ISO 639-1, e.g., cs. Optionally, a region subtag based on a two-letter country code from ISO 3166-1 alpha-2, e.g., cs_cz, or a three-digit code from UN M.49, e.g., es_419, separated by an underscore. Both the two-letter language code and the two-letter country code need to be lower case. Note that the Phrase Language AI setup dictates whether the region subtag is optional or not. If the only models deployed to a profile explicitly specify or are customized with a target locale, then a region subtag is mandatory.

Example:

"cs"

consumerId

string

required

Use short descriptive ID that represents the calling integration. E.g. JIRA_INTEGRATION, GDRIVE_SYNC, SHOPIFY_EXT:v1.2 etc.

Required string length: 1 - 50

sourceLang

object

Show child attributes

sourceLang.code

string

required

Language code, using a two-letter language code from ISO 639-1, e.g., cs. Optionally, a region subtag based on a two-letter country code from ISO 3166-1 alpha-2, e.g., cs_cz, or a three-digit code from UN M.49, e.g., es_419, separated by an underscore. Both the two-letter language code and the two-letter country code need to be lower case. Note that the Phrase Language AI setup dictates whether the region subtag is optional or not. If the only models deployed to a profile explicitly specify or are customized with a target locale, then a region subtag is mandatory.

Example:

"cs"

mtSettings

object

Show child attributes

mtSettings.profile

object

Show child attributes

mtSettings.profile.uid

string

required

UID for the translation profile

Example:

"CFUki8ptanoz1WAIYoXSH4"

Response

Response with translations

sourceLang

object

required

Show child attributes

sourceLang.code

string

required

Language code, using a two-letter language code from ISO 639-1, e.g., cs. Optionally, a region subtag based on a two-letter country code from ISO 3166-1 alpha-2, e.g., cs_cz, or a three-digit code from UN M.49, e.g., es_419, separated by an underscore. Both the two-letter language code and the two-letter country code need to be lower case. Note that the Phrase Language AI setup dictates whether the region subtag is optional or not. If the only models deployed to a profile explicitly specify or are customized with a target locale, then a region subtag is mandatory.

Example:

"cs"

targetLang

object

required

Show child attributes

targetLang.code

string

required

Language code, using a two-letter language code from ISO 639-1, e.g., cs. Optionally, a region subtag based on a two-letter country code from ISO 3166-1 alpha-2, e.g., cs_cz, or a three-digit code from UN M.49, e.g., es_419, separated by an underscore. Both the two-letter language code and the two-letter country code need to be lower case. Note that the Phrase Language AI setup dictates whether the region subtag is optional or not. If the only models deployed to a profile explicitly specify or are customized with a target locale, then a region subtag is mandatory.

Example:

"cs"

consumerId

string

required

Use short descriptive ID that represents the calling integration. E.g. JIRA_INTEGRATION, GDRIVE_SYNC, SHOPIFY_EXT:v1.2 etc.

Required string length: 1 - 50

translatedTexts

object[]

Show child attributes

translatedTexts.key

string

translatedTexts.target

string

API Documentation

Authorizations

Body

Response