REST reference

Not published yet

This page is a placeholder. The generated REST reference does not exist yet, and nothing on this page is a description of endpoints beyond what is already documented by hand elsewhere in these docs.

The reference on this page will be generated from the API’s own OpenAPI schema, rather than written by hand, so that it cannot drift from what the service actually accepts. Until the backend publishes that schema, the hand written pages are the accurate ones:

• Authentication for the key format and the Authorization header.
• Streaming over WebSocket for wss://api.utter.cc/v1/stream, its query parameters, the frame format and every event.
• Batch transcription for POST /v1/transcribe, its multipart fields and its response body.
• Latency tiers for GET /v1/tiers.
• Pricing and credits for GET /v1/credits, GET /v1/credits/ledger and GET /v1/usage.
• Errors for the error envelope and the status codes.

How it will be generated

The API is FastAPI, which serves an OpenAPI document describing every route it actually has. The plan is to pull that document at build time and render it into this section, so a route that changes shape changes these pages in the same commit.

The script stub lives at scripts/gen-reference.mjs in this repository, and docs/README.md explains how to run it once there is a schema to run it against. Nothing is generated today, and the stub deliberately fails with a clear message rather than emitting a plausible looking reference for endpoints nobody has built.