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.
Three transcription planes
| Plane | Endpoint | Body | Success | Who segments speech |
|---|---|---|---|---|
| Realtime | WS /v1/audio/transcriptions/stream | PCM16LE stream | WS events | Server (VAD) |
| Segment | POST /v1/audio/transcriptions | multipart/form-data | 200 sync | Client (VAD) |
| Batch jobs | POST /v1/audio/transcriptions/jobs | JSON audio_url | 202 async | Server (time slicing) |
Endpoints
| Endpoint | Method | Purpose | Auth |
|---|---|---|---|
/v1/audio/transcriptions/stream | WS | Realtime streaming transcription | Bearer sk-... or rt_... |
/v1/audio/transcriptions | POST | Segment transcription (multipart, sync) | Bearer sk-... |
/v1/audio/transcriptions/jobs | POST | Submit batch transcription job | Bearer sk-... |
/v1/audio/transcriptions/jobs/{workflowId} | GET | Poll batch job (preferred) | Bearer sk-... |
/v1/audio/transcriptions/{workflowId} | GET | Poll batch job (alias) | Bearer sk-... |
/{workflowId} | GET | Poll batch job (legacy alias) | 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 |
Legacy JSON on
POST /v1/audio/transcriptions
Still accepted temporarily with Deprecation: true and a Link to /jobs. Prefer POST /v1/audio/transcriptions/jobs for batch jobs.Service health board (latency / probe SLI) is not on this host. Use the public ops page:
- Production: https://control.lansonai.com/status/lanson-audio
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
Client-VAD speech segments
When and how to use synchronous segment transcription.
Admin API
Internal key management and plan catalog endpoints.
Resources
