İçeriğe geç
API Reference · v1

Build with Audexum.

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

Kimlik doğrulama

Bir API anahtarı oluştur: Geliştirici ayarları. Her istekte bunu Bearer token olarak gönderin.

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

POST/api/synthesize

Metinden ses oluştur. Şunu döndürür: audio/wav varsayılan olarak (44.1 kHz, 16-bit PCM, mono). Kullan format MP3/OGG/Opus için veya stream=true düşük gecikmeli parçalı akış için kullan.

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

İstek gövdesi

AlanYazVarsayılanNotlar
textstringvarsayılan requiredUp to ~5,000 characters per call.
voiceper tier (see Voice tiers)varsayılan AtlasVoice ids are tier-specific. The default follows backend.
langen, bg, ko, ja, ar, de, …varsayılan en33 supported. See /api/voices.
speed0.5–2.0varsayılan 1.05 (V1 and V3: 1.0)Speaking pace, on every engine except V4. Pitch is kept.
steps4–16varsayılan 8Diffusion steps. More = higher quality, slower.
formatwav | mp3 | ogg | opusvarsayılan wavOutput format. Quota is identical across formats.
streambooleanvarsayılan falseStream chunked WAV. Only format=wav, and V1/V2 only. V3 Expressive returns the whole file and ignores stream.
backendv3 | v2 | v1varsayılan v3Voice tier. Omit it and you get V3 Expressive. See Voice tiers below.
instructstringvarsayılan ""V3 only. Natural-language style/emotion, e.g. "warm and slow". Ignored by V1/V2.

Ses kademeleri

Şununla bir kademe seç: backend. Her kademenin kendi sesleri ve karakter başına kredi çarpanı vardır. Bir kademe için bilinmeyen bir ses göndermek 400 döndürür.

Şunu atlarsan: backend kademe otomatik belirlenir: V2 sesi (F1..F5, M1..M5) seni V2 Multilingual’de tutar, bir V3 sesi V3 Expressive’i seçer; hiçbirini belirtmezsen V3 Expressive alırsın:Atlas. Yalnızca birses gönderen mevcut entegrasyonlar etkilenmez ve faturalandırmaları kademelerinin çarpanıyla devam eder.

backendkadememaliyetises
v1V1 Instant: hızlı, önce İngilizce1×/api/voices adresine bak
v2V2 Multilingual: Bulgarca dâhil 32 dil1.5×F1..F5, M1..M5
v3V3 Expressive: en etkileyici; duygu ve üslup2×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

Yanıt başlıkları

AlanYazVarsayılanNotlar
Content-Typestringvarsayılan —audio/wav · audio/mpeg · audio/ogg · audio/opus
X-Gen-Time-Msintvarsayılan —Wall-clock generation time, ms.
X-Audio-Duration-Sfloatvarsayılan —Output audio duration, seconds.
X-RTFfloatvarsayılan —Audio / generation ratio. >1 = faster than real-time.
X-Formatstringvarsayılan —Echo of requested format.
X-Stream1varsayılan —Present when stream=true; body is concatenated WAV chunks.

Çıkış biçimleri (OGG / Opus / MP3)

Şunu ekle: "format": "ogg" (veya mp3 / opus) dönüştürülmüş bir yanıt al. Biçim ne olursa olsun kota aynıdır. AudioSeal filigranı MP3 kodlamasından sonra korunur.

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-TypeKodek
wavaudio/wavPCM 16-bit, 44.1 kHz (dönüştürme yok)
mp3audio/mpeglibmp3lame VBR ~192 kbps
oggaudio/ogglibopus 96 kbps, 48 kHz
opusaudio/opuslibopus 96 kbps, 48 kHz (Ogg kapsayıcı)

Akış TTS

Şunu ekle: "stream": true sesi oluşurken almanızı sağlar. Yanıt, birbirine eklenmiş WAV dosyalarından oluşan chunked-transfer akışıdır. Her parça geçerli ve eksiksiz bir WAV dosyasıdır (44 baytlık RIFF başlığı + PCM); böylece oynatmaya hemen başlayabilirsiniz. Kota, akışsız çağrıyla aynı şekilde metnin tamamı için baştan ayrılır. Akışlı kullanım için gerekli: format=wav (varsayılan) gerekir.

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.
Akış notları: metin cümle sınırlarında bölünür (parça başına yaklaşık 1–3 cümle). Biçim şu olmalıdır: wav. İlk parçanın gecikmesi sunucu tarafında kaydedilir. Yanıt başlığı X-Stream: 1 akış modunu onaylar.

POST/api/transcribe

Konuşmayı metne dönüştür. Sesi şu biçimde gönder: multipart/form-data. Şun gerekir: kısıtlamasız anahtar (widget anahtarları yalnızca /api/synthesizeuç noktasıyla sınırlıdır). Sesin her dakikası için 200 kredi faturalandırılır.

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

Form alanları

AlanNotlar
audioZorunlu. Bir audio/* dosyası; en fazla 25 MB ve 600 saniye.
timestampsİsteğe bağlı boolean. Bölüm başına başlangıç ve bitiş zamanlarını ekler.
vocabularyİsteğe bağlı. Tanımayı yönlendirmek için en fazla 2000 karakterlik alana özel terimler.
clean / modeİsteğe bağlı. Transkripti sonrasında işle (clean, email, professional, bullets, concise).

Yanıt

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 uyumlu konuşmadan metne. OpenAI temel URL’sini değiştirmene izin veren bir araç, bunu şu değere ayarlayarak Audexum’u kullanabilir: https://audexum.com/v1, kod değişikliği gerekmez. Şununla aynı motoru ve faturalandırmayı kullanır: /api/transcribe: sesin her dakikası için 200 kredi. Gönder multipart/form-data.

Yetkilendirme Authorization: Bearer sk_live_…şu şekilde: Anahtarı Geliştirici ayarları oluştur (oturum açmak gerekir). Gizli bir sk_live_ anahtar; kısıtlı widget anahtarları burada 403 alır.

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)

Form alanları

AlanYazVarsayılanNotlar
filefilevarsayılan requiredUp to 25 MB and 600 seconds. Content-Type audio/*, video/webm, video/ogg or application/octet-stream (mp3, wav, m4a, ogg, flac, webm).
modelstringvarsayılan —Accepted and ignored: there is one engine. Send whisper-1.
languageISO 639-1, e.g. bgvarsayılan autoOptional. Omit it and the language is detected.
response_formatjson | text | verbose_json | srt | vttvarsayılan jsonAn unknown value falls back to json.
timestamp_granularities[]segment | wordvarsayılan segmentverbose_json only. word adds a words array (see below).
promptstringvarsayılan —Accepted and ignored.
temperaturefloatvarsayılan 0Accepted and ignored.

verbose_json

Segment başlangıç/bitiş zaman damgaları motordan gelir. Kelime zamanlamaları (timestamp_granularities[]=word) tahmin edilir: her segmentin süresi, karakter sayısına göre kelimelerine bölünür. Zorunlu hizalama yapılmaz. Her segment şunun bilgisini taşır: kelime anahtarı, kelime istemediysen boş.

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": [] }
  ]
}

Desteklenmiyor

  • POST /v1/audio/translations 405 döner.
  • Akışlı transkripsiyon ve Realtime API.

Hatalar

KodGövde
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

Tek istekte en fazla 50 metin gönder. Tamamlanmasını bekle, ardından bir zip indir.

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

Webhook'lar

Webhook uç noktanı Geliştirici ayarları bölümünde yapılandır; imzalı POST bildirimleri almak için. Sana bir X-Audexum-Signature başlığı. İşlemeden önce doğrulayın.

Payload yapısı

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"
}

Olaylar

AlanYazVarsayılanNotlar
quota.warning_80stringvarsayılan —Fired when monthly quota crosses 80% used.
quota.exhaustedstringvarsayılan —Fired when monthly quota is fully consumed.
batch.completedstringvarsayılan —Fired when a batch job finishes.
audiobook.completedstringvarsayılan —Fired when an audiobook job finishes.

İmza doğrulama

Her teslimat şunları içerir: X-Audexum-Signature: sha256=<hex>, webhook sırrınız kullanılarak ham istek gövdesi üzerinde HMAC-SHA256 olarak hesaplanır.

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"
Yalnızca HTTPS uç noktaları. HTTP reddedilir.
Özel/loopback IP’ler engellenir (SSRF koruması).
5 s zaman aşımı, üstel geri çekilmeyle 2 yeniden deneme (1 s, 2 s).
Teslimat, gönder ve unut şeklindedir: bir sentez isteğini hiçbir zaman engellemez.

Hatalar

KodAnlam
400Geçersiz istek: geçersiz ses/dil, boş metin veya akışlı + wav olmayan biçim
401API anahtarı eksik veya geçersiz
402insufficient_credits: Aylık kota aşıldı; yükseltme seçenekleri için /api/usage ve /pricing sayfalarına bakın
402feature_gated: Özellik daha yüksek bir plan gerektiriyor (error.feature ve error.min_tier alanlarına bakın)
422Geçersiz webhook URL’si (HTTPS değil, özel IP veya çözülemiyor)
429Çok fazla istek: istek hızınızı azaltın ve tekrar deneyin
503Sunucu meşgul (eşzamanlılık sınırına ulaşıldı): üstel geri çekilmeyle tekrar deneyin; Retry-After yönergesine uyun

Hız sınırları ve adil kullanım

  • Ortak eşzamanlılık sınırı: sınırı aşan istekler 503 + Retry-After alır
  • Sürekli aşırı istek hızları kısıtlanabilir (adil kullanım)
  • Plan seviyene göre aylık kredi kotası
  • Ayrılmış kapasite veya PAYG için bizimle iletişime geç

Takıldın mı? E-posta gönder: [email protected].

İlk çağrınız tek bir curl uzağınızda.