Skip to main content
GET
Get WebSocket connection URL
Get a WebSocket connection URL for receiving real-time updates from a collection. Use this for live notifications about upload progress, transcription completion, and other async events.
  • WebSocket URLs are temporary and should be reconnected if the connection drops
  • Use the ws_connection_id from the WebSocket handshake in other API calls to receive targeted updates

Authorizations

x-access-token
string
header
required

API key for authentication (sk-xxx format)

Path Parameters

collection_id
string
required
Example:

"default"

Response

200 - application/json

WebSocket URL

success
boolean
Example:

true

data
object