API Reference

This root chapter contains transport-level contracts for backend integrations, services, and custom clients.

• HTTP API Reference: Routes, auth rules, request/response payloads, error codes, and the live OpenAPI 3.1 routine document at GET /v1/api/openapi.json.
• WebSocket Protocol: Auth handshake, subscription lifecycle, message schema, limits, and protocol errors.

For SQL command syntax, use SQL Reference. For user-defined server functions (CALL, /v1/functions, topic triggers), see Server Functions. Named types: CREATE TYPE. For first-time server setup/login endpoint usage, see Authentication & Bootstrap.