WebSocket event stream

Upgrades an active stream subscription to a WebSocket connection. Supply that subscription's stream_id and authenticate with either a short-lived signed ticket from POST /v1/stream/tickets or the x-api-key header. Concurrent connections are capped by plan and are not separately billable; delivered events are billed in the same delivery-event family as stream polling and are idempotent per subscription and event.

get/v1/stream/ws

Request

  • Base URL: https://api.turos.app
  • URL: https://api.turos.app/v1/stream/ws
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Query parameters

stream_idstring required

ID of an active stream subscription configured for WebSocket delivery.

ticketstring

Short-lived signed stream ticket minted from POST /v1/stream/tickets. Provide this or the x-api-key header.

cursorstring

Resume delivery after a previously observed stream cursor. Events after this cursor are replayed on connect.

Headers

x-api-keystring

API key for the WebSocket upgrade. Provide this or a short-lived ticket query parameter.

Response

Contract-aware error response

object'error' required
idstring required
codestring required
typestring required
messagestring required
requestIdstring required
traceparentstring
hintstring
docsUrlstring uri
detailsobject required

Changes

No recorded changes to this operation across all 1 revision of this API.