Skip to content

Translate a new document

Translate a document from a TranscriptSession result

Use correct API token

It is important that the correct API token is used for document translation. Only the token linked to the TranscriptSession can be used.

URL: POST https://api.scriptix.io/api/v3/speech-to-text/session/${sessionId}/document/:document_id/translate

Request headers

The following headers need to be present

Parameter Value Description
Content-Type application/json
X-Zoom-S2T-Key Scriptix Batch API Token API key belonging to TranscriptSession

Request path arguments

Argument Description
sessionId Scriptix Transcript Session ID returned from a Batch Session
documentId Scriptix Document ID returned from a Get Document or Create Document

JSON Body Schema

One of the available languages, use it as the value for the language key in the schema below

Bulgarian = "BG"
Czech = "CS"
Danish = "DA"
German = "DE"
Greek = "EL"
English = "EN"
Spanish = "ES"
Estonian = "ET"
Finnish = "FI"
French = "FR"
Hungarian = "HU"
Italian = "IT"
Japanese = "JA"
Lithuanian = "LT"
Latvian = "LV"
Dutch = "NL"
Polish = "PL"
Portuguese = "PT"
Romanian = "RO"
Russian = "RU"
Slovak = "SK"
Slovenian = "SL"
Swedish = "SV"
Chinese = "ZH"
Turkish = "TR"
Norwegian = "NB"
Korean = "KO"
Indonesian = "ID"
Ukrainian = "UK"


Key Type Description
language Enum[string]: "EN", "FR" Language key to translate to
filename string[200] The name for the document.
webhook_headers string[] (Optional) Array of headers that needs to be present in the callback request. Requires webhook_url to be set.

Headers must be formatted in the following format: Custom-Header-Name: Header Value
webhook_method Enum: POST, PUT Default: POST

(Optional) Specify the method to use for the HTTP callback. Requires webhook_url to be set.
webhook_url string (Optional) If set a HTTPS callback will be made to a web endpoint once the transcription is done.
copy_webhook_settings boolean (Optional) If you want to copy the webhook settings from the original document.

Translate a new document to multiple languages

Translate a document from a TranscriptSession result

Use correct API token

It is important that the correct API token is used for document translation. Only the token linked to the TranscriptSession can be used.

URL: POST https://api.scriptix.io/api/v3/speech-to-text/session/${sessionId}/document/:document_id/translate-multiple

Request headers

The following headers need to be present

Parameter Value Description
Content-Type application/json
X-Zoom-S2T-Key Scriptix Batch API Token API key belonging to TranscriptSession

Request path arguments

Argument Description
sessionId Scriptix Transcript Session ID returned from a Batch Session
documentId Scriptix Document ID returned from a Get Document or Create Document

JSON Body Schema for Multiple Translations

Some or all of the available languages, use it as the value for the languages key in the schema below

Bulgarian = "BG"
Czech = "CS"
Danish = "DA"
German = "DE"
Greek = "EL"
English = "EN"
Spanish = "ES"
Estonian = "ET"
Finnish = "FI"
French = "FR"
Hungarian = "HU"
Italian = "IT"
Japanese = "JA"
Lithuanian = "LT"
Latvian = "LV"
Dutch = "NL"
Polish = "PL"
Portuguese = "PT"
Romanian = "RO"
Russian = "RU"
Slovak = "SK"
Slovenian = "SL"
Swedish = "SV"
Chinese = "ZH"
Turkish = "TR"
Norwegian = "NB"
Korean = "KO"
Indonesian = "ID"
Ukrainian = "UK"


Key Type Description
languages List[Enum[string]]: ["EN", "FR"] Language keys to translate to
filename string[200] The name for the document.
webhook_headers string[] (Optional) Array of headers that needs to be present in the callback request. Requires webhook_url to be set.

Headers must be formatted in the following format: Custom-Header-Name: Header Value
webhook_method Enum: POST, PUT Default: POST

(Optional) Specify the method to use for the HTTP callback. Requires webhook_url to be set.
webhook_url string (Optional) If set a HTTPS callback will be made to a web endpoint once the transcription is done.
copy_webhook_settings boolean (Optional) If you want to copy the webhook settings from the original document.

Responses codes

Status code Description
201 Document created
400 Bad request, JSON payload may be invalid
401 Unauthorized, no valid authentication found
403 Forbidden, access to resource is not allowed
404 Not found, the transcript session is not found or does not belong to the provided API token
500 The document type is not saved in the format it should be, contact Admin