API Reference Overview
Base URL, REST/WebSocket endpoints, versioning.
API Reference — Overview
Base URL
https://audio.lansonai.com
All relative paths in this reference are relative to this domain.
Endpoints
| Endpoint | Method | Purpose | Auth |
|---|---|---|---|
/v1/audio/transcriptions/stream | WS | Realtime streaming transcription | Bearer sk-... or rt_... session token |
/v1/audio/transcriptions | POST | Submit offline transcription job | Bearer sk-... |
/{workflowId} | GET | Poll transcription job status | Bearer sk-... |
/v1/audio/transcriptions/session-token | POST | Issue short-lived browser WebSocket token | Bearer sk-... |
/health | GET | Liveness check | Public |
/readyz | GET | Realtime readiness check | Public |
/openapi.json | GET | OpenAPI specification | Public |
/docs | GET | Swagger UI | Public |
Versioning
The current version uses the /v1/... path prefix. Future breaking changes will use /v2/...; /v1/ will remain supported during a reasonable transition period.
Authentication
All transcription endpoints require an API key via Authorization: Bearer sk-.... See Authentication for browser-side session token flow.
Page layout
Each endpoint page follows a consistent template:
- What it does — functional description
- Endpoint — URL and method
- Authentication — auth requirements
- Request — request format
- Parameters — parameter reference
- Example — code example
- Response — response format
- Errors — relevant error codes
- Related — links to guides and concepts