Skip to content

Start a connection

You can reach our API service by using the WebSocket Secure (WSS) protocol. The endpoint is:

wss://realtime.scriptix.io/v2/realtime?language=language-code

Where language-code can be retrieved from the API portal for supported languages, it is preferred but is optional (if not passed as a query parameter then the engine will detect automatically).

Request headers

The following headers need to be present upon connection

Parameter Value Description
x-zoom-s2t-key Scriptix Realtime API Token (Optional) API key of type real-time needed for authorization. If omitted, the API key can be provided during the start action.

Query parameters

Parameter Value Description
language xx Language identifier in standard ISO-639-1 for speech-to-text-session