Skip to content

Initiate batch session

Initiate a new asynchronous Speech to Text session for a specific language.

URL: POST https://api.scriptix.io/api/v2/speech-to-text/session

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 of type real-time needed for authorization

JSON Body Schema

Key Type Description
language string Set the language for this session. A list of available languages can be retrieved from the API portal.
callback_url string (Optional) If set a HTTPS callback will be made to a web endpoint once the transcription is done.
callback_method string (Optional) Enum: POST, PUT. Specify the method to use for the HTTP callback. Requires callback_url to be set.
callback_headers string[] (Optional) Array of headers that needs to be present in the callback request. Requires callback_url to be set.
punctuation boolean Default: false. If set to true punctuation will be enabled.

JSON Payload

{
    "language": "en-us",
    "callback_url": "https://example.com/zoom_callback",
    "callback_method": "POST",
    "callback_headers": [
        "X-Internal-ID: QW5zd2VyIG9mIGxpZmUK"
    ],
    "punctuation": false
}

Responses

Status code Description Payload
200 New session initialized
400 Invalid language
401 Unauthorized
415 Content Invalid
422 Body Invalid
500 Server Error