Realtime API reference

Available WebSocket messages for session start, audio frames, transcript events, translation events, usage and terminal states.

Open the console ↗Read the docs

Interface example

Start with a request.
Inspect every field.

Use a project API key from your server and follow the capability status documented on this page.

curl https://api.audelyr.ai/v1/realtime/sessions \
  -H "Authorization: Bearer $AUDELYR_API_KEY" \
  -H "Idempotency-Key: realtime-demo-001" \
  -H "Content-Type: application/json" \
  -d '{"audio":{"format":"pcm_s16le","sample_rate_hz":16000,"channels":1}}'

Integration reference

Endpoints, parameters
and response contracts.

Production base URL: https://api.audelyr.ai. Keep API keys on your server. Every POST that creates work accepts an Idempotency-Key; reuse the same key only with the same request body.

POSThttps://api.audelyr.ai/v1/realtime/sessions

Create a realtime session and receive a short-lived browser token.

Auth: Bearer aud_live_… (server only)

Headers: Idempotency-Key (16–255 chars) · Content-Type: application/json

audioobjectyesformat pcm_s16le or webm_opus; mono; PCM sample rate 8/16/24/48 kHz.

language_hintsstring[]noOptional BCP-47 language hints, max 10.

translationobjectnoOptional one_way target_language or bidirectional languages pair.

contextstringnoOptional session-scoped speech context, 1-2,000 characters.

custom_vocabularystring[]noOptional request-scoped recognition terms, max 100 unique terms of 120 characters each; combined with context and never retained as a project glossary.

Response: 201 RealtimeSessionCredentials: session_id, websocket_url, single-use session_token (5 min).

GEThttps://api.audelyr.ai/v1/realtime/sessions/{session_id}

Read session status and timestamps.

Auth: Bearer aud_live_…

session_idstringyesID beginning ses_.

Response: 200 RealtimeSession

POSThttps://api.audelyr.ai/v1/realtime/sessions/{session_id}/token

Rotate a token during reconnect.

Auth: Bearer aud_live_…

Headers: Idempotency-Key (16–255 chars)

Response: 201 RealtimeSessionCredentials

Overview

Available WebSocket messages for session start, audio frames, transcript events, translation events, usage and terminal states.

Before you begin

Create a project API key in the console and keep it on your server.

Request lifecycle

Realtime connections return events as audio is processed. HTTP and SSE endpoints return structured errors when a request cannot run.

Availability

Each guide states whether its capability is available today or still planned. Do not send production traffic to an endpoint marked unavailable.

Early Access

Build the interface
before the infrastructure.

Explore the honest Preview, then tell us what production voice needs from Audelyr.

Create an account Contact sales