Developer documentation

Not verified

Transcription API reference

Offline transcription accepts M4A and other supported formats through an Audelyr upload_id, HTTPS audio URL or file reference. Browser and server files use a short-lived signed upload policy; Audelyr deletes processed objects and Cloud Storage applies a one-day lifecycle fallback.

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/transcriptions \
  -H "Authorization: Bearer $AUDELYR_API_KEY" \
  -H "Idempotency-Key: offline-demo-001" \
  -H "Content-Type: application/json" \
  -d '{"audio_url":"https://example.com/audio.wav","language_hints":["en"]}'

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/transcription-uploads

Create a short-lived signed POST policy for a browser or server audio file. POST every returned upload_fields entry plus a file field directly to upload_url, then use the returned id as upload_id.

Auth: Bearer aud_live_… (server only; return only the signed policy to a browser)

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

content_typesupported audio MIME typeyesExact multipart MIME type. M4A accepts audio/mp4, audio/x-m4a or audio/m4a.

size_bytesintegernoOptional exact byte length; maximum 500,000,000 bytes.

filenamestringnoOriginal filename; required with application/octet-stream and used to validate the audio extension.

Response: 201 upload grant: id (upl_), upload_url, upload_method POST, upload_fields, expires_at, max_bytes and content_type.

POSThttps://api.audelyr.ai/v1/transcriptions

Queue offline transcription for exactly one upload_id, HTTPS audio URL or file reference. Each upload_id is consumed once atomically and processed by a private worker.

Auth: Bearer aud_live_… (server only)

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

upload_idupl_ IDnoAudelyr upload returned by POST /v1/transcription-uploads.

audio_urlhttps:// URLnoExisting HTTPS audio URL.

file_idstringnoPreviously registered file reference.

audio_urihttps:// URLnoCompatibility alias for audio_url; gs:// is not accepted.

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

translationobjectnoOptional one-way target or bidirectional language pair for speech translation; this is not text translation.

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

custom_vocabularystring[]noOptional job-scoped recognition terms, max 100 unique terms; not a persistent project glossary.

Response: 202 JSON with id (ofq_) and status queued.

GEThttps://api.audelyr.ai/v1/transcriptions/{transcription_id}

Poll an offline job. Successful files are metered by processed audio duration at $0.005/min; failed jobs are not charged. Audelyr then cleans up hosted source objects.

Auth: Bearer aud_live_…

Response: 200 status, transcript, translated_text, detected_language, audio_ms, billing and error.

Overview

Before you begin

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

Supported offline audio

Asynchronous transcription accepts AAC, AIFF, AMR, ASF, FLAC, MP3, OGG, WAV, WebM, M4A and MP4. For M4A uploads use audio/mp4, audio/x-m4a or audio/m4a. Realtime WebSocket input remains PCM16 or WebM/Opus.

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