body_src |
YES |
String |
Original body of text (to be translated) |
lc_src |
YES |
String |
Source language code. Gengo uses IETF codes to define languages and language pairs |
lc_tgt |
YES |
String |
Target language code |
tier |
YES |
String |
Quality level (“standard” or “pro”) |
type |
YES |
String |
Job type. Either ‘text’ (default) or ‘file’. Use ‘file’ for ordering file jobs via the API using job identifiers from the file quote function |
slug |
YES |
String |
Job title. For internally storing, can be generic |
identifier |
if type is file |
String |
The identifier returned as a response from the file quote method (e.g. identifier = ‘2ea3a2dbea3be97375ceaf03200fb184’) |
glossary_id |
|
Integer |
Id of the glossary that you want to use |
position |
|
Integer |
The position of the job in a group of jobs. Starts at 1.
When the job group is displayed to translators, this ensures that ordering is maintained. |
force |
|
Bool(1/0) |
Whether or not to override duplicate detection and force a new translation.
(always returns a fresh translation, even if the term has been translated before) |
comment |
|
String |
Instructions or comments for translator to consider when translating. It is strongly encouraged to provide a detailed comment for the translator |
attachments |
|
Array |
Contains Dictionaries. Each attachment must have a separate Dictionary containing the following required parameters |
Parameter |
Type |
Description |
url |
String |
Link to an external file providing extra context to a job. Only accepts public URLs with http(s) scheme. |
filename |
String |
The name of the external file to be attached ex| ‘image.jpg’/’video.mp4’/’audio.mpeg’/... |
mime_type |
String |
The following mime types will display a preview to the translator:
image/bmp|jpg|jpeg|png|gif, video/mp4, audio/mpeg. Other mime types will display a download link to the translator. |
services |
|
Array |
Plus service. To place a translation order with extra quality assurance ex| ‘services’: [‘translation’, ‘edit’] |
purpose |
|
String |
Describing the purpose of the translation ex| “Personal use/Business/Online content/Web or app localization/Other... |
tone |
|
String |
Describing the tone for the translation ex| “Informal/Friendly/Business/Formal/Other... |
use_preferred |
|
Bool(1/0) |
Whether to use translators from the preferred translators list associated with the account |
callback_url |
|
String |
The full URL to which we will send system updates (completed jobs, new comments, etc.) |
auto_approve |
|
Bool(1/0) |
Whether to automatically approve jobs after they’ve been translated. Default is false
If false, completed jobs will await review and approval by customer for 72 hours |
custom_data |
|
String |
Up to 1K of storage for client-specific data that may be helpful for you to have mapped to this job |
max_chars |
|
Integer |
Expresses character limit of translation. Should always be greater than 0 |
as_group |
|
Bool(1/0) |
By default, jobs from the same language pair and tier will be grouped within a single collection which means that only one translator for
this language pair and tier will be able to pick up the whole collection.
If as_group is set to 0 each job can be picked up by a different translator. |