WebSocket Secure (WSS) API Documentation for /transcribe endpoint
/transcribe
API enables real-time, bidirectional communication with the Corti system for stateless speech-to-text. Clients can send and receive structured data, including transcripts and detected commands.
This documentation provides a comprehensive guide for integrating these capabilities.
/transcribe
endpoint supports real-time stateless dictation.Environment | Description |
---|---|
us | US-based instance |
eu | EU-based instance |
wss://
scheme.
tenant-name
parameter a token
parameter to pass in the Bearer access token.CONFIG_ACCEPTED
before transmitting other data.
If the configuration is not valid it will return CONFIG_DENIED
.
The configuration must be committed within 10 seconds of opening the WebSocket, else it will time-out with CONFIG_TIMEOUT
.
period
or slash
into .
or /
.beta
status. API details subject to change ahead of general release.Defining formatting configuration is optional
. When these preferences are not configured, the default
values listed below will be applied automatically.type: end
.
This will signal the server to send any remaining transcript segments and detected commands before the server sends a usage message
ended
, and then closes.
connect
),
the socket will close itself without reconnecting when it receives an ENDED
message.
When using manual configuration, the socket will attempt to reconnect after the server closes the connection. To prevent this,
you must subscribe to the ended
message and manually close the connection.
CONFIG_DENIED
, CONFIG_TIMEOUT
usage
and type ENDED
.
CONFIG_DENIED
, etc.) and runtime errors will both trigger the error
event and automatically close the socket. You can also inspect the original message in the message
handler. With manual configuration, configuration errors are only received as messages (not as error
events), and you must close the socket manually to avoid reconnection.