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

PlaneEndpointBodySuccessWho segments speech
RealtimeWS /v1/audio/transcriptions/streamPCM16LE streamWS eventsServer (VAD)
SegmentPOST /v1/audio/transcriptionsmultipart/form-data200 syncClient (VAD)
Batch jobsPOST /v1/audio/transcriptions/jobsJSON audio_url202 asyncServer (time slicing)

Endpoints

EndpointMethodPurposeAuth
/v1/audio/transcriptions/streamWSRealtime streaming transcriptionBearer sk-... or rt_...
/v1/audio/transcriptionsPOSTSegment transcription (multipart, sync)Bearer sk-...
/v1/audio/transcriptions/jobsPOSTSubmit batch transcription jobBearer sk-...
/v1/audio/transcriptions/jobs/{workflowId}GETPoll batch job (preferred)Bearer sk-...
/v1/audio/transcriptions/{workflowId}GETPoll batch job (alias)Bearer sk-...
/{workflowId}GETPoll batch job (legacy alias)Bearer sk-...
/v1/audio/transcriptions/session-tokenPOSTIssue short-lived browser WebSocket tokenBearer sk-...
/healthGETLiveness checkPublic
/readyzGETRealtime readiness checkPublic
/openapi.jsonGETOpenAPI specificationPublic
/docsGETSwagger UIPublic
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:

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
Reference pages are for field facts This section does not contain product narratives or tutorials. For concepts, see Concepts. For integration guides, see Guides.