WebSocket Ingest
GET
/recordings/{recordingId}/ingest/ws
Stream recording payloads over a WebSocket connection. This is the default method used in our JavaScript SDK. See WebSocket Ingest for more details, or use the HTTP ingest route for a simpler method.
Note: Since browsers cannot send custom headers with WebSocket requests, the SDK automatically appends your API key as a query parameter (?token=your-api-key) to the WebSocket URL.
Please ignore reference to the Bearer HTTP Authentication header here until we can update this documentation to include support for interacting with websockets. The GET method is correct insofar as it refers to the initial upgrade part of the websocket connection negotiation.
Authorizations
Public API Key
Public API key for authentication.
Parameters
Path Parameters
recordingId*
The recording ID
Type
Requiredstring
Example
"000e8400-e00b-00d0-a716-446655440000"Format
"uuid"Query Parameters
debug
Enable debug mode
Type
string
Example
"true"contentType
Payload content type. Defaults to application/x-ndjson when omitted.
Type
string
Valid values
"application/x-ndjson""application/ndjson""application/json"Example
"application/x-ndjson"contentEncoding
Optional compression applied to the payload frames. Defaults to identity.
Type
string
Valid values
"gzip""br""zstd"Example
"gzip"Responses
WebSocket upgraded successfully.