Skip to main content
GET
/
collection
/
{collection_id}
/
websocket
Get WebSocket connection URL
curl --request GET \
  --url https://api.videodb.io/collection/{collection_id}/websocket \
  --header 'x-access-token: <api-key>'
{
  "success": true,
  "data": {
    "websocket_url": "wss://ws.videodb.io/..."
  }
}
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