{"type":"doc","content":[{"type":"heading","attrs":{"level":2},"content":[{"text":"Authentication","type":"text"}]},{"type":"paragraph","content":[{"text":"Authentication must be provided in the request header as ","type":"text"},{"text":"Authorization: Bearer ","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"API keys for segment-based translation","type":"text"}]},{"type":"paragraph","content":[{"text":"A valid API key can be:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A user's API key. The user must have ","type":"text"},{"text":"translate","type":"text","marks":[{"type":"code"}]},{"text":" permission in the group the engine belongs to.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"An API key for translation that has been assigned to the engine.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Parameters necessary for making a request","type":"text"}]},{"type":"paragraph","content":[{"text":"Apart from the sentences to be translated, the following information is always required for making successful requests – and should never be hardcoded in client implementations:","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"b5be76e7-839b-4321-abcf-cee9a015ef9c"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[166.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[794.0]},"content":[{"type":"paragraph","content":[{"text":"Usage","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[166.0]},"content":[{"type":"paragraph","content":[{"text":"Service base URL","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[794.0]},"content":[{"type":"paragraph","content":[{"text":"Requests must be sent to this base URL + ","type":"text"},{"text":"/api/v1","type":"text","marks":[{"type":"code"}]},{"text":" + the endpoint.","type":"text"}]},{"type":"paragraph","content":[{"text":"This URL is determined by the region in which the engine is deployed.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[166.0]},"content":[{"type":"paragraph","content":[{"text":"API key","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[794.0]},"content":[{"type":"paragraph","content":[{"text":"Must be sent among the request headers as ","type":"text"},{"text":"Authorization: Bearer ","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[166.0]},"content":[{"type":"paragraph","content":[{"text":"Engine ID","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[794.0]},"content":[{"type":"paragraph","content":[{"text":"The UUID of the engine to be used for translating segments. Must be sent in the JSON payload as ","type":"text"},{"text":"engine_id","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Endpoints","type":"text"}]},{"type":"paragraph","content":[{"text":"The latest API version is v1.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /translations","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"JSON payload","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"f17bfeeb-c9be-48cb-884a-7029958a1934"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[141.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[118.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[118.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[583.0]},"content":[{"type":"paragraph","content":[{"text":"Usage","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[141.0]},"content":[{"type":"paragraph","content":[{"text":"engine_id","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[118.0]},"content":[{"type":"paragraph","content":[{"text":"yes","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[118.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[583.0]},"content":[{"type":"paragraph","content":[{"text":"The UUID of the engine to use.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[141.0]},"content":[{"type":"paragraph","content":[{"text":"sentences","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[118.0]},"content":[{"type":"paragraph","content":[{"text":"yes","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[118.0]},"content":[{"type":"paragraph","content":[{"text":"string[]","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[583.0]},"content":[{"type":"paragraph","content":[{"text":"The sentences to be translated. They can be:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Plain text","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"XML fragment","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Well-formed XLIFF 1.2 or XLIFF 2.1 (there is no need to wrap/envelope the sentences in anything, i.e. you can send whatever is ","type":"text"},{"text":"inside","type":"text","marks":[{"type":"em"}]},{"text":" the ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" tag)","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[141.0]},"content":[{"type":"paragraph","content":[{"text":"format","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[118.0]},"content":[{"type":"paragraph","content":[{"text":"no","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[118.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[583.0]},"content":[{"type":"paragraph","content":[{"text":"The format of ","type":"text"},{"text":"all","type":"text","marks":[{"type":"em"}]},{"text":" the sentences sent in the same request in the ","type":"text"},{"text":"sentences","type":"text","marks":[{"type":"code"}]},{"text":" array.","type":"text"}]},{"type":"paragraph","content":[{"text":"Accepted values:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"text-plain","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"xliff:1.2","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"xliff:2.1","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"yellow","style":"bold","text":"Globalese 4.1.2+","localId":"9b757811-bb23-42cc-ac17-6dea2e3ae3b0"}},{"text":" ","type":"text"},{"text":"xml","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"paragraph","content":[{"type":"status","attrs":{"color":"yellow","style":"bold","text":"Globalese 4.1.2+","localId":"033dff17-2dee-40d8-b20e-79a658958c11"}},{"text":" If this parameter is not provided, Globalese will use its best guess. It is recommended to always specify the format if known and never leave it to Globalese to auto-detect, whenever the format is known.","type":"text"}]},{"type":"paragraph","content":[{"text":"In case translatable segments have different formats, they must be sent in separate requests.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Limits","type":"text"}]},{"type":"paragraph","content":[{"text":"The maximum request size is 100 kilobytes.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Example request","type":"text"}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"engine_id\": \"\",\n \"format\": \"xliff:1.2\",\n \"sentences\": [\n \"Sentence one.\",\n \"Sentence two.\"\n ]\n}","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Example response","type":"text"}]},{"type":"paragraph","content":[{"text":"A successful response has a 201 response code and the following body structure:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"sentences\": [\n \"Translation one.\",\n \"Translation two.\"\n ]\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Other response codes:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"400 Bad Request","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"401 Unauthorized","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"413 Payload Too Large","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"500 Internal Server Error","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"502 Bad Gateway (error during translation)","type":"text"}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"cURL example","type":"text"}]},{"type":"paragraph","content":[{"text":"The following request shows a full cURL request to ","type":"text"},{"text":"/translations","type":"text","marks":[{"type":"code"}]},{"text":":","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"curl --location --request POST '/api/v1/translations' \\\n--header 'Authorization: Bearer ' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"engine_id\": \"\",\n \"format\": \"xliff:1.2\",\n \"sentences\" : [\n \"Sentence one.\",\n \"Sentence two.\"\n ]\n}'","type":"text"}]}],"version":1}

Browser not supported