API Documentation

Version 1 · Last updated 2026-05-12

Getting started

The Streaming API exposes a packet-up transport over HTTP/2 with a long-lived downlink and short bursty uplinks. Connect to /api/v1/stream with a valid session token and you'll receive a server-sent stream of framed packets.

Authentication

Sessions are identified by an opaque auth_token cookie established at connect time. The token is rotated on every reconnect.

Endpoints

GET /api/v1/health

HTTP/1.1 200 OK
Content-Type: application/json

{"status":"ok"}

GET /api/v1/version

HTTP/1.1 200 OK
Content-Type: application/json

{"name":"streaming-api","version":"v1.4.2","build":"2026.05.12+abc1234"}

GET /api/v1/stream

Opens a downlink stream. Server holds the connection and pushes packets as they arrive.

POST /api/v1/stream

Sends an uplink packet. Body is opaque to the API.

Rate limits

TierConcurrent sessionsUplink kbps
Free2256
Pro164096
Enterpriseunlimitednegotiated

Errors

CodeMeaning
400Malformed request or missing session
401Token expired or invalid
429Rate limit exceeded
503Backend unavailable, retry with backoff