Kullanım Kılavuzu API Başvuru Kılavuzu

Başlarken

İlk API isteğinizi yapmak için ihtiyacınız olan her şey

Temel URL’ler

Moknah, kullanım senaryonuza bağlı olarak iki tür uç nokta sunar:

Standart REST API (tekil talepler için):

https://moknah.io/api/v1/

Gerçek zamanlı WebSocket API (kesintisiz yayın için):

wss://moknah.io/api/v1/

Kimlik Doğrulama

Moknah API’si ... kullanır API anahtarları kimlik doğrulama için. API anahtarınızı şuraya dahil edin: Authorization ...kullanarak başlık Hamil her HTTP isteği ve WebSocket el sıkışması ile birlikte şema.

Authorization: Bearer YOUR_API_KEY

API Anahtarınızı Alma

  1. Hesabınıza giriş yapın Moknah Paneli
  2. Pro Plana abone olun veya iletişime geçin Satış kurumsal erişim için.
  3. Şuraya git: API
  4. Tıkla API Anahtarlarını Yönet
  5. Tıkla Yeni Anahtar
  6. Anahtarınızı kopyalayın ve güvenli bir şekilde saklayın.
Anahtarınızı güvende tutun

API anahtarınızı asla istemci tarafındaki kodlarda veya herkese açık depolarda açığa çıkarmayın. Ona bir parola gibi muamele edin.

Hızlı HTTP Örneği

İşte standart REST API’sini kullanarak metinden konuşma oluşturmaya yönelik eksiksiz bir örnek:

curl -X POST "https://moknah.io/api/v1/tts/generate/" \
  -H "Authorization: Bearer your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "مرحبا بك في منصة مكنة",
    "voice_id": 1
  }' \
  --output speech.mp3
import requests

response = requests.post(
    "https://moknah.io/api/v1/tts/generate/",
    headers={
        "Authorization": f"Bearer your_api_key",
    },
    json={
        "text": "مرحبا بك في منصة مكنة",
        "voice_id": 1
    }
)

if response.status_code == 200:
    with open("speech.mp3", "wb") as f:
        f.write(response.content)
    print("Ses kaydedildi!")
else:
    print(f"Hata: {response.json()}")
const response = await fetch(
    'https://moknah.io/api/v1/tts/generate/',
    {
        method: 'POST',
        headers: {
            'Authorization': 'Bearer your_api_key',
            'Content-Type': 'application/json'
        },
        body: JSON.stringify({
            text: 'مرحبا بك في منصة مكنة',
            voice_id: 1
        })
    }
);

if (response.ok) {
    const blob = await response.blob();
    // Ses blobunu kullanın
    console.log("Ses oluşturuldu!");
} else {
    const error = await response.json();
    console.error(error);
}

Yanıt Formatı

Başarı Yanıtları

Başarılı yanıtlar uç noktaya göre değişiklik gösterir:

  • TTS Oluştur (POST): Tam ikili ses verisini (audio/mpeg) döndürür
  • TTS Akışı (WSS): İkili MP3 parçalarını, oluşturuldukları anda kesintisiz olarak aktarır.
  • Diğer uç noktalar: Yapılandırılmış JSON verisi döndürür

Hız Sınırı Başlıkları (Yalnızca HTTP)

Her HTTP yanıtı, hız sınırı bilgilerini içerir (WebSockets, sınırları bağlantı kapatma yoluyla uygular):

Üst Bilgi Açıklama
RateLimit-Limit Dakika başına maksimum istek sayısı
RateLimit-Remaining Mevcut pencerede kalan istekler
RateLimit-Reset Sınırın sıfırlandığı Unix zaman damgası
Moknah-Credits-Remaining Kalan kredi bakiyeniz

Yaygın Hata Kodları

Kod Tür Açıklama
400 INVALID_REQUEST Geçersiz parametreler veya hatalı biçimlendirilmiş JSON
401 UNAUTHORIZED Geçersiz veya eksik API anahtarı
402 INSUFFICIENT_CREDITS Hesapta yeterli kredi bulunmuyor.
429 RATE_LIMIT_EXCEEDED Çok fazla istek (HTTP)
4290 CONCURRENT_LIMIT Çok fazla etkin bağlantı (WSS)
500 INTERNAL_SERVER_ERROR Sunucu hatası
Daha fazla bilgi edin

Şuna bir bakın Hatalar Ayrıntılı hata işleme rehberliği için sayfa.

Sonraki Adımlar

Kurulumu tamamladığınıza göre, mevcut uç noktaları keşfedin:

GÖNDERİ Sesleri Listele

TTS için kullanılabilir sesleri al

GÖNDERİ Konuşma Oluştur

Metni sese dönüştür

WSS Konuşma Akışı

Gerçek zamanlı WebSocket TTS

GÖNDERİ Konuşmayı yazıya dök

Ses dosyasından metin çıkar

WSS Yayın Dökümü

Gerçek zamanlı WebSocket STT

API Desteği

API ile ilgili soru veya sorunlarınız için bizimle şu adresten iletişime geçin: api@moknah.io.