Moknah Doku
Kostenlos starten
API-Referenz

Erste Schritte

Alles, was Sie für Ihre erste API-Anfrage benötigen

Basis-URLs

Moknah bietet je nach Anwendungsfall zwei Arten von Endpunkten:

Standard-REST-API (für einzelne Anfragen):

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

Echtzeit-WebSocket-API (für kontinuierliches Streaming):

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

Authentifizierung

Die Moknah-API verwendet API-Schlüssel zur Authentifizierung. Fügen Sie Ihren API-Schlüssel im Header Authorization mit dem Schema Bearer bei jeder HTTP-Anfrage und jedem WebSocket-Handshake hinzu.

Authorization: Bearer YOUR_API_KEY

Ihren API-Schlüssel abrufen

  1. Melden Sie sich an bei Ihrem Moknah-Dashboard
  2. Abonnieren Sie den Pro-Tarif oder kontaktieren Sie den Vertrieb für den Enterprise-Zugang.
  3. Navigieren Sie zu API
  4. Klicken Sie auf API-Schlüssel verwalten
  5. Klicken Sie auf Neuer Schlüssel
  6. Kopieren Sie Ihren Schlüssel und bewahren Sie ihn sicher auf
Halten Sie Ihren Schlüssel sicher

Geben Sie Ihren API-Schlüssel niemals in clientseitigem Code oder öffentlichen Repositories preis. Behandeln Sie ihn wie ein Passwort.

Schnelles HTTP-Beispiel

Hier ist ein vollständiges Beispiel zum Generieren von Sprache aus Text über die Standard-REST-API:

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("Audio gespeichert!")
else:
    print(f"Fehler: {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();
    // Audio-Blob verwenden
    console.log("Audio generiert!");
} else {
    const error = await response.json();
    console.error(error);
}

Antwortformat

Erfolgsantworten

Erfolgsantworten variieren je nach Endpunkt:

  • TTS-Generierung (POST): Gibt vollständige binäre Audiodaten im angeforderten output_format zurück (standardmäßig audio/mpeg)
  • TTS-Stream (WSS): Streamt fortlaufend binäre MP3-Fragmente, sobald sie generiert werden
  • Weitere Endpunkte: Gibt strukturierte JSON-Daten zurück

Rate-Limit-Header (nur HTTP)

Jede HTTP-Antwort enthält Rate-Limit-Informationen (WebSockets setzen Limits durch Verbindungsabbrüche durch):

Header Beschreibung
RateLimit-Limit Maximale Anfragen pro Minute
RateLimit-Remaining Verbleibende Anfragen im aktuellen Zeitfenster
RateLimit-Reset Unix-Zeitstempel für das Zurücksetzen des Limits
Moknah-Credits-Remaining Ihr verbleibendes Credit-Guthaben

Häufige Fehlercodes

Code Typ Beschreibung
400 INVALID_REQUEST Ungültige Parameter oder fehlerhaftes JSON
401 UNAUTHORIZED Ungültiger oder fehlender API-Schlüssel
402 INSUFFICIENT_CREDITS Das Konto verfügt nicht über genügend Credits
429 RATE_LIMIT_EXCEEDED Zu viele Anfragen (HTTP)
4290 CONCURRENT_LIMIT Zu viele aktive Verbindungen (WSS)
500 INTERNAL_SERVER_ERROR Serverfehler
Mehr erfahren

Siehe die Seite Fehler für detaillierte Hinweise zur Fehlerbehandlung.

Nächste Schritte

Nachdem Sie nun alles eingerichtet haben, erkunden Sie die verfügbaren Endpunkte:

POST Stimmen auflisten

Verfügbare Stimmen für TTS abrufen

POST Sprache generieren

Text in Audio umwandeln

WSS Sprache streamen

Echtzeit-WebSocket-TTS

POST Sprache transkribieren

Text aus Audiodatei extrahieren

WSS Transkription streamen

Echtzeit-WebSocket-STT

API-Support

Bei Fragen oder Problemen rund um die API kontaktieren Sie uns unter api@moknah.io.