GETTING STARTED
API REFERENCE
Text-Based Translation
Supported Languages
The Bering API supports text translations using the following languages:
Language
API Argument
English
en
Korean
ko
Japanese
ja
Chinese (Simplified)
zh
Chinese (Traditional)
zh-hant
French
fr
German
de
Spanish
es
Indonesian
id
Arabic
ar
The table below shows the supported translation language pairs:
Translate From
Translate To
en
ko, jp, zh, zh-hant, fr, de, es, id
ko
en
jp
en
zh
en
zh-hant
en
fr
en
de
en
es
en
id
en
ar
en
HTTP Request
The total request body size for text translation requests must not exceed 1MB.
We recommend splitting up your text if you want to translate in excess of this limit.
Host: https://api.beringlab.com
POST Endpoint: /v1/text-translate
Request Body Description
Body parameter
Description
source_language (required)
string (enum) target_language (required)
string (enum) source_content (required)
Text to be translated. Defaults to interpreting argument as plain text. For XML, set the kind parameter to ‘xml_docx’.
Type: string (UTF-8 encoded)
domain (required)
string (enum) subscription_id (required)
Found on the Settings page under ‘API plan Subscription ID’. See Access and Authentication for more details.
string api_key (required)
Your API Key generated in Access and Authentication.
string kind (optional)
Used when passing XML to the source_content parameter.
string glossary_id (optional)
Used when specifying a glossary to apply to the translation
string Response Body Description
Body parameter
Description
job_id
ID used to get the translated text.
string status_code
Status of the API request
Type: integer
POST Endpoint: /v1/glossaries/{glossary-id} Request Body Description
Body parameter
Description
subscription_id (required)
Found on the Settings page under ‘API plan Subscription ID’. See Access and Authentication for more details.
string api_key (required)
Your API Key generated in Access and Authentication.
string Response Body Description
Body parameter
Description
id
ID of the glossary. It can be found using GET method for glossaries listed below.
string name
Name of the glossary
string owner_id
Glossary owner’s ID which is the same as subscription_id.
Type: string
owner_type
Glossary owner’s account type. Either corporate or individual
string mappings
Glossary entries shown as a Hashmap
Type: Hashmap
source_language (required)
string (enum) target_language (required)
string (enum) POST Endpoint: /v1/glossaries
Request Body Description
glossary_name (required)
Name of glossary
Type: string
source_language (required)
string (enum) target_language (required)
string (enum) mappings (required)
Glossary entries shown as a Hashmap
Type: Hashmap
subscription_id (required)
Found on the Settings page under ‘API plan Subscription ID’. See Access and Authentication for more details.
string api_key (required)
Your API Key generated in Access and Authentication.
string Response Body Description
Body parameter
Description
status_code
Status of the API request
Type: string
PUT Endpoint: /v1/glossaries/{glossary-id} Request Body Description
mappings (required)
Glossary entries shown as a Hashmap
Type: Hashmap
subscription_id (required)
Found on the Settings page under ‘API plan Subscription ID’. See Access and Authentication for more details.
string api_key (required)
Your API Key generated in Access and Authentication.
string Response Body Description
Body parameter
Description
status_code
Status of the API request
Type: string
DELETE Endpoint: /v1/glossaries/{glossary-id} Request Body Description
subscription_id (required)
Found on the Settings page under ‘API plan Subscription ID’. See Access and Authentication for more details.
string api_key (required)
Your API Key generated in Access and Authentication.
string Response Body Description
Body parameter
Description
status_code
Status of the API request
Type: string
GET Endpoint: /v1/glossaries?subscription_id={subscription_id}&api_key={api_key} Response Body Description
Body parameter
Description
id
ID of the glossary.
string name
Name of the glossary
string source_language
string (enum) target_language
string (enum) POST Endpoint: /v1/text-translate/status/{job_id} Request Body Description
Body parameter
Description
subscription_id (required)
Found on the Settings page under ‘API plan Subscription ID’. See Access and Authentication for more details.
string api_key (required)
Your API Key generated in Access and Authentication.
string Response Body Description
Body parameter
Description
text
The translated text.
string status_code
Status of the API request
Type: integer