Create Realtime Ws Token

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

const options = {method: 'POST', headers: {'capout-api-key': '<api-key>'}};

fetch('https://api.capout.ai/ws/token', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "token": "<string>",
  "organization_id": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "ws_url": "/ws/status",
  "sse_url": "/sse/status"
}

Create Realtime Ws 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
- &recent=10 to subscribe to the most recent organization-owned documents

WebSocket example:

wss://api.capout.ai/ws/status?token=<token>&document_id=doc_123

SSE example:

https://api.capout.ai/sse/status?token=<token>&recent=10

After a WebSocket connection is established, clients can send JSON commands such as:

{"action":"subscribe","document_ids":["doc_123"]}

POST

token

Create Realtime Ws Token

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

const options = {method: 'POST', headers: {'capout-api-key': '<api-key>'}};

fetch('https://api.capout.ai/ws/token', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "token": "<string>",
  "organization_id": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "ws_url": "/ws/status",
  "sse_url": "/sse/status"
}

Authorizations

capout-api-key

string

header

required

Organization-scoped CapOut API key

Response

200 - application/json

Successful Response

Response body for POST /ws/token.

token

string

required

Short-lived realtime token for query-param auth

organization_id

string

required

Organization bound to this realtime token

expires_at

string<date-time>

required

UTC expiration time for the realtime token

ws_url

string

default:/ws/status

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

sse_url

string

default:/sse/status

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

Overview

Upload

Status

ESX Downloads

Claims

Realtime

Create Realtime Ws Token

Authorizations

Response