Developer documentation

Mixed availability

API reference

Explore the versioned speech, translation and realtime endpoints, authorization requirements and error envelopes.

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.

POST/api/platform/v1/organizations

Console-internal same-origin route for creating an organization; it is not a customer server API.

Auth: Firebase ID token from the signed-in Console

Headers: Idempotency-Key · Content-Type: application/json

namestringyesOrganization display name.

Response: 201 organization resource.

GET/api/platform/v1/projects/{project_id}/usage

Console-internal route for reading project usage. GET /v1/usage is not a public API.

Auth: Firebase ID token from the signed-in Console

Response: 200 usage summary.

POST/api/platform/v1/organizations/{organization_id}/billing/checkout

Create a Stripe Checkout URL for a credit pack or subscription.

Auth: Firebase ID token; server-side Stripe secret remains in control-api

Headers: Idempotency-Key · Content-Type: application/json

kindcredit_pack|subscriptionyesCheckout product kind.
price_idstringyesServer-allowlisted Stripe Price ID.

Response: 201 checkout_session_id and redirect URL.

POST/api/platform/v1/webhooks

Register a signed webhook destination.

Auth: Firebase ID token or control credential

Headers: Idempotency-Key · Content-Type: application/json

Response: 201 webhook endpoint and signing secret metadata.

01

Overview

Explore the versioned speech, translation and realtime endpoints, authorization requirements and error envelopes.

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.