Към съдържанието
API Reference · v1

Build with Audexum.

REST API. Bearer auth. JSON in, WAV/MP3/OGG/Opus out. Streaming and webhooks included.

Удостоверяване

Генерирайте API ключ от Настройки за разработчици. Изпращайте го като Bearer токен при всяко заявка.

http
Authorization: Bearer sk_live_•••••••••••••••••••••••••••••••••

POST/api/synthesize

Генерирайте аудио от текст. По подразбиране връща audio/wav (44,1 kHz, 16-bit PCM, моно). Използвайте format за MP3/OGG/Opus или stream=true за нискозакъснително поточно предаване на части.

curl
# The shortest call there is. No backend named, so you get
# V3 Expressive on the Atlas voice — our most expressive engine.
curl -X POST https://audexum.com/api/synthesize \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{"text": "Hello world"}' \
  --output hello.wav

# V2 Multilingual, where speed and steps apply and 32 languages are available.
curl -X POST https://audexum.com/api/synthesize \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "text": "Hello world",
    "backend": "v2",
    "voice": "M1",
    "lang": "en",
    "speed": 1.05,
    "steps": 8
  }' \
  --output hello.wav

Тяло на заявката

ПолеВъведетеПо подразбиранеБележки
textstringпо подразбиране requiredUp to ~5,000 characters per call.
voiceper tier (see Voice tiers)по подразбиране AtlasVoice ids are tier-specific. The default follows backend.
langen, bg, ko, ja, ar, de, …по подразбиране en33 supported. See /api/voices.
speed0.5–2.0по подразбиране 1.05 (V1 and V3: 1.0)Speaking pace, on every engine except V4. Pitch is kept.
steps4–16по подразбиране 8Diffusion steps. More = higher quality, slower.
formatwav | mp3 | ogg | opusпо подразбиране wavOutput format. Quota is identical across formats.
streambooleanпо подразбиране falseStream chunked WAV. Only format=wav, and V1/V2 only. V3 Expressive returns the whole file and ignores stream.
backendv3 | v2 | v1по подразбиране v3Voice tier. Omit it and you get V3 Expressive. See Voice tiers below.
instructstringпо подразбиране ""V3 only. Natural-language style/emotion, e.g. "warm and slow". Ignored by V1/V2.

Нива на гласовете

Изберете ниво с backend. Всяко ниво има собствени гласове и множител на кредитите за всеки знак. Изпращането на непознат глас за дадено ниво връща 400.

Ако пропуснете backend нивото, то се определя автоматично: V2 глас (F1..F5, M1..M5) ви оставя на V2 Multilingual, избирането на V3 глас активира V3 Expressive, а ако не посочите нито един, получавате V3 Expressive приAtlas. Съществуващите интеграции, които изпращат самоглас , не се засягат и запазват таксата от множителя на съответното си ниво.

backendнивоценагласове
v1V1 Instant: бърз, ориентиран към английския език1×Вижте /api/voices
v2V2 Multilingual: 32 езика, включително български1.5×F1..F5, M1..M5
v3V3 Expressive: най-изразителен, с емоции и стил2×Atlas, Reid, Sage, Kai, Cole, Ivy, Mira, Elle, Nova
curl
# V3 Expressive — most expressive tier, with an optional style prompt
curl -X POST https://audexum.com/api/synthesize \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "text": "We shipped it. Finally.",
    "backend": "v3",
    "voice": "Atlas",
    "instruct": "warm, relieved, unhurried"
  }' \
  --output ultra.wav

Заглавки на отговора

ПолеВъведетеПо подразбиранеБележки
Content-Typestringпо подразбиране —audio/wav · audio/mpeg · audio/ogg · audio/opus
X-Gen-Time-Msintпо подразбиране —Wall-clock generation time, ms.
X-Audio-Duration-Sfloatпо подразбиране —Output audio duration, seconds.
X-RTFfloatпо подразбиране —Audio / generation ratio. >1 = faster than real-time.
X-Formatstringпо подразбиране —Echo of requested format.
X-Stream1по подразбиране —Present when stream=true; body is concatenated WAV chunks.

Формати на изхода (OGG / Opus / MP3)

Добавете "format": "ogg" (или mp3 / opus), за да получите прекодиран отговор. Квотата е еднаква независимо от формата. Водният знак AudioSeal се запазва при MP3 кодиране.

curl
# OGG/Opus — smallest file size, best for streaming/web
curl -X POST https://audexum.com/api/synthesize \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{"text": "Hello", "voice": "M1", "lang": "en", "format": "ogg"}' \
  --output hello.ogg

# MP3 — maximum compatibility
curl -X POST https://audexum.com/api/synthesize \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{"text": "Hello", "voice": "M1", "lang": "en", "format": "mp3"}' \
  --output hello.mp3
python
import requests

r = requests.post(
    "https://audexum.com/api/synthesize",
    headers={"Authorization": "Bearer sk_live_..."},
    json={"text": "Hello world", "voice": "M1", "lang": "en", "format": "ogg"},
)
r.raise_for_status()
with open("hello.ogg", "wb") as f:
    f.write(r.content)
# Content-Type: audio/ogg
formatContent-TypeКодек
wavaudio/wavPCM 16-bit, 44,1 kHz (без прекодиране)
mp3audio/mpeglibmp3lame VBR ~192 kbps
oggaudio/ogglibopus 96 kbps, 48 kHz
opusaudio/opuslibopus 96 kbps, 48 kHz (Ogg контейнер)

Стрийминг TTS

Добавете "stream": true за да получавате аудио по време на генерирането. Отговорът е поток от chunked transfer, съдържащ съединени WAV файлове. Всеки chunk е пълен, валиден WAV файл (44-байтов RIFF header + PCM), така че можете да започнете възпроизвеждането веднага. Квотата се резервира предварително за целия текст, както при заявка без стрийминг. Стриймингът изисква format=wav (по подразбиране).

curl
curl -X POST https://audexum.com/api/synthesize \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{"text": "Sentence one. Sentence two. Sentence three.", "voice": "M1", "lang": "en", "stream": true}' \
  --no-buffer --output - | ffplay -nodisp -i pipe:0
python
import requests

with requests.post(
    "https://audexum.com/api/synthesize",
    headers={"Authorization": "Bearer sk_live_..."},
    json={
        "text": "First sentence. Second sentence. Third one.",
        "voice": "M1",
        "lang": "en",
        "stream": True,
    },
    stream=True,
) as r:
    r.raise_for_status()
    with open("streamed.wav", "wb") as f:
        for chunk in r.iter_content(chunk_size=None):
            f.write(chunk)
# Each yielded chunk is a standalone WAV file (header + PCM).
# Concatenating them produces valid gapless audio.
Бележки за поточно предаване: текстът се разделя по граници на изречения (~1–3 изречения на част). Форматът трябва да бъде wav. Закъснението до първата част се записва в сървъра. Заглавният ред на отговора X-Stream: 1 потвърждава режима на поточно предаване.

POST/api/transcribe

Транскрибирайте реч в текст. Изпращайте аудиото като multipart/form-data. Изисква неограничен ключ (ключовете за widget са ограничени до /api/synthesize). Таксува се с 200 кредита за минута аудио.

curl
curl -X POST https://audexum.com/api/transcribe \
  -H "Authorization: Bearer sk_live_..." \
  -F "[email protected]" \
  -F "timestamps=true"

Полета на формуляра

ПолеБележки
audioЗадължително. Аудио файл audio/*, до 25 MB и 600 секунди.
timestampsНезадължителна булева стойност. Включване на начално/крайно време за всеки сегмент.
vocabularyНезадължително. До 2000 знака от домейнови термини за насочване на разпознаването.
clean / modeНезадължително. Обработете транскрипта след това (clean, email, professional, bullets, concise).

Отговор

json
{
  "text": "Full transcript…",
  "duration_s": 12.3,
  "transcribe_ms": 480,
  "segments": [{ "start": 0.0, "end": 3.2, "text": "…" }],
  "raw_text": "…",   // present only when a clean/transform mode was requested
  "mode": "clean"
}

POST/v1/audio/transcriptions

Съвместим с OpenAI speech-to-text. Инструмент, който позволява промяна на основния URL адрес на OpenAI, може да използва Audexum, като го зададе на https://audexum.com/v1, без промяна в кода. Използва същия engine и същото billed as /api/transcribe: 200 кредита за минута аудио. Изпратете multipart/form-data.

Удостоверяването е Authorization: Bearer sk_live_…. Създайте ключа в Настройки за разработчици (необходимо е вход). Използвайте секретен sk_live_ ключ; ограничените widget ключове тук получават 403.

curl
curl https://audexum.com/v1/audio/transcriptions \
  -H "Authorization: Bearer sk_live_..." \
  -F [email protected] \
  -F model=whisper-1 \
  -F language=bg \
  -F response_format=json
# {"text": "…"}
python
from openai import OpenAI

client = OpenAI(api_key="sk_live_...", base_url="https://audexum.com/v1")

with open("recording.mp3", "rb") as f:
    result = client.audio.transcriptions.create(
        model="whisper-1",
        file=f,
        language="bg",   # optional; omit to auto-detect
    )
print(result.text)

Полета на формуляра

ПолеВъведетеПо подразбиранеБележки
filefileпо подразбиране requiredUp to 25 MB and 600 seconds. Content-Type audio/*, video/webm, video/ogg or application/octet-stream (mp3, wav, m4a, ogg, flac, webm).
modelstringпо подразбиране —Accepted and ignored: there is one engine. Send whisper-1.
languageISO 639-1, e.g. bgпо подразбиране autoOptional. Omit it and the language is detected.
response_formatjson | text | verbose_json | srt | vttпо подразбиране jsonAn unknown value falls back to json.
timestamp_granularities[]segment | wordпо подразбиране segmentverbose_json only. word adds a words array (see below).
promptstringпо подразбиране —Accepted and ignored.
temperaturefloatпо подразбиране 0Accepted and ignored.

verbose_json

Сегмент start/end идват от двигателя. Времената на думите (timestamp_granularities[]=word) са изчислени: временният обхват на всеки сегмент се разпределя между думите според дължината им в знаци. Те не са изравнени принудително. Всеки сегмент съдържа words ключ, който е празен, освен ако не сте поискали думи.

json
{
  "task": "transcribe",
  "language": "bg",          // echo of the request; "auto" when omitted
  "duration": 12.3,
  "text": "Full transcript…",
  "segments": [
    { "id": 0, "start": 0.0, "end": 3.2, "text": "…", "words": [] }
  ]
}

Не се поддържа

  • POST /v1/audio/translations връща 405.
  • Транскрибиране в реално време и Realtime API.

Грешки

КодТяло
400{"detail": "audio_too_short"} · "no_speech_detected" · "clip_too_long: max 600s per request"
401{"detail": "authentication_required"}: missing or invalid key
402{"detail": {"error": "insufficient_credits", …}}: full body below
403{"detail": "email_not_verified"}: verify the account's email address
405{"detail": "Method Not Allowed"}: /v1/audio/translations
413{"detail": "audio_too_large"}: file over 25 MB
415{"detail": "unsupported_media_type"}: file part is not audio
json
// 402 — the balance cannot cover this file
{
  "detail": {
    "error": "insufficient_credits",
    "plan_tier": "free",
    "monthly_grant": 250,
    "monthly_used": 250,
    "pack_credits": 0,
    "requested": 41,
    "upgrade_url": "/pricing",
    "offer": {
      "reason": "insufficient_credits",
      "headline": "You are out of credits",
      "detail": "This request needs 41 credits. …",
      "plan": { "tier": "pro", "price_eur": 29, "credits_per_month": 1200000 },
      "actions": [
        { "kind": "upgrade", "label": "Upgrade to Pro — €29/mo", "url": "https://audexum.com/r/402" },
        { "kind": "pack", "label": "Buy 250,000 credits — €7", "url": "https://audexum.com/pricing#packs" }
      ]
    }
  }
}

POST/api/batch

Изпращайте до 50 текста в една заявка. Изчакайте завършването, след което изтеглете ZIP файл.

curl
# submit
curl -X POST https://audexum.com/api/batch \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{"texts": ["one", "two"], "voice": "F2", "lang": "en"}'

# poll
curl -H "Authorization: Bearer sk_live_..." \
  https://audexum.com/api/batch/$JOB_ID

# download once status=done
curl -H "Authorization: Bearer sk_live_..." \
  https://audexum.com/api/batch/$JOB_ID/download -O

Webhooks

Настройте крайна точка за webhook във вашия Настройки за разработчици за да получавате подписани POST известия. Изпращаме JSON с X-Audexum-Signature header. Проверете го преди обработката.

Формат на payload

json
{
  "event": "quota.warning_80",
  "data": {
    "monthly_grant": 3000,
    "monthly_used": 24000,
    "monthly_remaining": 6000,
    "overage_enabled": false,
    "plan_tier": "free",
    "period_end": "2026-06-30"
  },
  "timestamp": "2026-06-12T14:22:00.000000+00:00"
}

Събития

ПолеВъведетеПо подразбиранеБележки
quota.warning_80stringпо подразбиране —Fired when monthly quota crosses 80% used.
quota.exhaustedstringпо подразбиране —Fired when monthly quota is fully consumed.
batch.completedstringпо подразбиране —Fired when a batch job finishes.
audiobook.completedstringпо подразбиране —Fired when an audiobook job finishes.

Проверка на подписа

Всяко изпращане включва X-Audexum-Signature: sha256=<hex>, изчисен като HMAC-SHA256 върху необработените данни на заявката, с използване на вашия webhook secret.

python
import hashlib, hmac

def verify_signature(body: bytes, secret: str, sig_header: str) -> bool:
    expected = "sha256=" + hmac.new(
        secret.encode(), body, hashlib.sha256
    ).hexdigest()
    return hmac.compare_digest(expected, sig_header)

# In your FastAPI/Flask/Django handler:
# body = await request.body()
# sig  = request.headers["X-Audexum-Signature"]
# if not verify_signature(body, WEBHOOK_SECRET, sig):
#     return 401
curl
# Configure endpoint (session auth — browser only)
curl -X PUT https://audexum.com/api/account/webhook \
  -H "Cookie: audexum_session=..." \
  -H "X-Requested-With: XMLHttpRequest" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://your-server.com/webhooks/audexum"}'
# Response contains secret — store it, shown once only.

# Remove endpoint
curl -X DELETE https://audexum.com/api/account/webhook \
  -H "Cookie: audexum_session=..." \
  -H "X-Requested-With: XMLHttpRequest"
Само HTTPS endpoints. HTTP се отхвърля.
Частни/loopback IP адреси са блокирани (защита от SSRF).
Тайм-аут 5 s, 2 повторни опита с експоненциално отлагане (1 s, 2 s).
Доставката е fire-and-forget: никога не блокира заявка за синтез.

Грешки

КодЗначение
400Невалидна заявка: невалиден voice/lang, празен текст или стрийминг с не-wav формат
401Липсващ или невалиден API ключ
402insufficient_credits: Месечната квота е надхвърлена; вижте /api/usage и /pricing за варианти за надграждане
402feature_gated: Функцията изисква по-висок план (вижте error.feature и error.min_tier)
422Невалиден webhook URL (не е HTTPS, частен IP адрес или не може да бъде разрешен)
429Твърде много заявки: намалете честотата на заявките и опитайте отново
503Сървърът е зает (постигнат е лимитът за едновременни заявки): опитайте отново с експоненциално забавяне; спазвайте Retry-After

Ограничения на честотата и справедливо използване

  • Споделен лимит за едновременни заявки: заявките над него получават 503 + Retry-After
  • Продължително злоупотребяване с честотата на заявките може да бъде ограничено (честна употреба)
  • Месечна квота кредити според нивото на плана ви
  • Свържете се с нас за специален капацитет или PAYG

Имате проблем? Пишете на [email protected].

Първото ви извикване е на един curl разстояние.