Skip to main content
POST
Open a realtime connection

Authorizations

x-api-key
string
header
required

Workspace API key. Current accepted keys use the ando_sk_ prefix.

Body

application/json

Public realtime connection-opening request.

subscriptions
object[]
required

Realtime subscriptions to authorize for this connection.

Required array length: 1 element
resume_from
object

Bounded realtime resume request.

Response

Opened temporary realtime connection.

Temporary public realtime websocket connection details.

approximate_connection_time_seconds
number | null
required

Approximate maximum connection lifetime in seconds. Resume near a cursor deadline can shorten it.

connection_id
string
required

Realtime connection identifier.

Example:

"01jzn7e61x3a7v9h2r7t2m3q4p"

expires_at
string<date-time>
required

Timestamp when the returned connection URL expires if unused. Resume near a cursor deadline can shorten the normal URL lifetime.

Example:

"2026-05-14T08:00:00.000Z"

expires_in_seconds
integer
required

Seconds until the returned connection URL expires if unused, capped by any resume-cursor deadline.

Required range: x >= 1
heartbeat_interval_seconds
integer
required

Recommended heartbeat interval for the socket.

Required range: x >= 1
protocol
enum<string>
required

Required websocket subprotocol.

Available options:
ando.realtime.v1
resume_supported
boolean
required

Whether bounded resume is supported for this connection.

resume_cursor
string
required

Safe cursor for the connection's initial ledger floor. Persist it before opening the websocket, then replace it only after the server confirms an ordered acknowledgement or sends a planned-disconnect checkpoint.

Required string length: 1 - 4096
subscriptions
object[]
required

Canonical subscriptions authorized for the socket.

Required array length: 1 element
url
string
required

Temporary pre-authorized websocket URL. Treat the ticket query parameter as secret.