API Reference

Realtime

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Create a realtime streaming ticket

POST/v2/realtime/ticket

Exchange your API key (or session) for a short-lived ticket that authenticates a connection to the realtime object-change stream. Open a WebSocket to the push endpoint with the returned ticket as the token query parameter. The ticket is single-purpose and expires quickly; call this again to obtain a fresh one before reconnecting.

ReturnsExpand Collapse

expires_in: number

Seconds until the ticket expires. Refresh (call the endpoint again) before reconnecting.

ticket: string

Short-lived token authenticating a realtime WebSocket connection. Pass as the token query parameter when connecting.

ws_url: string

WebSocket URL for this environment (wss://stream.developers[.staging].micro.so). Connect here with the ticket as the token query parameter.

Create a realtime streaming ticket

HTTP

HTTP

TypeScript

Python

Go

CLI Tool

curl https://developers.micro.so/v2/realtime/ticket \
    -X POST \
    -H "x-api-key: $MICRO_API_KEY"

200 example

{
  "expires_in": 0,
  "ticket": "ticket",
  "ws_url": "ws_url"
}

Returns Examples

200 example

{
  "expires_in": 0,
  "ticket": "ticket",
  "ws_url": "ws_url"
}