Developer documentation

Not verified

Speech API reference

Available endpoints: POST /v1/speech/synthesize and POST /v1/speech/streams for SSE streaming synthesis.

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/speech/synthesize \
  -H "Authorization: Bearer $AUDELYR_API_KEY" \
  -H "Idempotency-Key: tts-demo-001" \
  -H "Content-Type: application/json" \
  -d '{"text":"Hello from Audelyr","voice":"nova","audio_format":"mp3"}'

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/speech/synthesize

Generate audio from text.

Auth: Bearer aud_live_… (server only)

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

textstringyes1–5,000 characters.
voicenova|alloy|shimmernoDefaults to nova.
languageBCP-47noDefaults to en-US.
audio_formatmp3|ogg_opus|linear16noDefaults to mp3.
sample_rate_hzintegerno8/16/24/48 kHz; defaults to 24 kHz.

Response: 200 JSON with audio_base64, content_type, characters and replayed.

POSThttps://api.audelyr.ai/v1/speech/streams

Stream synthesis as Server-Sent Events.

Auth: Bearer aud_live_… (server only)

Headers: Idempotency-Key · Accept: text/event-stream

Response: 200 SSE: audio.chunk then audio.completed.

01

Overview

Available endpoints: POST /v1/speech/synthesize and POST /v1/speech/streams for SSE streaming synthesis.

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.