Developer documentation

Preview API

Quickstart

Create a project API key, then create a realtime session or call an HTTP endpoint from your server.

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}}'
01

Overview

Create a project API key, then create a realtime session or call an HTTP endpoint from your server.

02

Before you begin

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

03

Request lifecycle

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

04

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.