Create realtime token

curl --request POST \
  --url https://api.capout.ai/ws/token \
  --header 'capout-api-key: <api-key>'

{
  "token": "rt_123",
  "organization_id": "org_123",
  "expires_at": "2026-04-14T14:45:00Z",
  "ws_url": "/ws/status",
  "sse_url": "/sse/status"
}

Create realtime token

Mint a short-lived realtime token for WebSocket or SSE authentication.

Connection flow:

Call POST /ws/token with your capout-api-key.
Read token, ws_url, and sse_url from the response.
Connect to wss://api.capout.ai/ws/status?token=<token> for WebSocket updates, or https://api.capout.ai/sse/status?token=<token> for Server-Sent Events.
Optionally scope the initial subscription with either document_id=<document_id> repeated one or more times, or recent=10 to subscribe to the most recent organization-owned documents.

After a WebSocket connection is established, clients can send JSON commands such as {"action":"subscribe","document_ids":["doc_123"]}.

POST

token

Create realtime token

curl --request POST \
  --url https://api.capout.ai/ws/token \
  --header 'capout-api-key: <api-key>'

{
  "token": "rt_123",
  "organization_id": "org_123",
  "expires_at": "2026-04-14T14:45:00Z",
  "ws_url": "/ws/status",
  "sse_url": "/sse/status"
}

Authorizations

capout-api-key

string

header

default:capout_test_your_api_key

required

Organization-scoped API key used for REST endpoints and for minting realtime tokens.

Response

Successful response

Response body for POST /ws/token.

token

string

required

Short-lived realtime token for query-parameter auth.

Example:

"rt_123"

organization_id

string

required

Organization bound to this realtime token.

Example:

"org_123"

expires_at

string<date-time>

required

UTC expiration time for the realtime token.

Example:

"2026-04-14T14:45:00Z"

ws_url

string

default:/ws/status

WebSocket path to connect to with ?token=<token>.

Example:

"/ws/status"

sse_url

string

default:/sse/status

SSE path to connect to with ?token=<token>.

Example:

"/sse/status"

Get credits

SSE status stream

Documentation Index

Authorizations

Response