Moknah Dokumentacja
Zacznij za darmo
Dokumentacja API

Pierwsze kroki

Wszystko, czego potrzebujesz, aby wykonać pierwsze żądanie API

Bazowe adresy URL

Moknah udostępnia dwa typy punktów końcowych w zależności od zastosowania:

Standardowe REST API (dla pojedynczych żądań):

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

WebSocket API w czasie rzeczywistym (do ciągłego przesyłania strumieniowego):

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

Uwierzytelnianie

API Moknah używa kluczy API do uwierzytelniania. Dołącz swój klucz API w nagłówku Authorization używając schematu Bearer przy każdym żądaniu HTTP i uzgadnianiu połączenia WebSocket.

Authorization: Bearer YOUR_API_KEY

Uzyskiwanie klucza API

  1. Zaloguj się na swoje Panel Moknah
  2. Zasubskrybuj plan Pro lub skontaktuj się z działem Sprzedaży w sprawie dostępu dla firm.
  3. Przejdź do API
  4. Kliknij Zarządzaj kluczami API
  5. Kliknij Nowy klucz
  6. Skopiuj i bezpiecznie zapisz swój klucz
Chroń swój klucz

Nigdy nie ujawniaj klucza API w kodzie po stronie klienta ani w publicznych repozytoriach. Traktuj go jak hasło.

Szybki przykład HTTP

Oto kompletny przykład generowania mowy z tekstu za pomocą standardowego 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("Zapisano plik audio!")
else:
    print(f"Błąd: {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();
    // Użyj obiektu blob audio
    console.log("Wygenerowano audio!");
} else {
    const error = await response.json();
    console.error(error);
}

Format odpowiedzi

Odpowiedzi powodzenia

Odpowiedzi powodzenia różnią się w zależności od punktu końcowego:

  • Generowanie TTS (POST): Zwraca pełne binarne dane audio w żądanym output_format (domyślnie audio/mpeg)
  • Strumieniowanie TTS (WSS): Przesyła strumieniowo binarne fragmenty MP3 w miarę ich generowania
  • Inne punkty końcowe: Zwraca ustrukturyzowane dane JSON

Nagłówki limitu zapytań (tylko HTTP)

Każda odpowiedź HTTP zawiera informacje o limicie zapytań (WebSockets egzekwują limity poprzez zamykanie połączeń):

Nagłówek Opis
RateLimit-Limit Maksymalna liczba żądań na minutę
RateLimit-Remaining Pozostałe zapytania w bieżącym oknie
RateLimit-Reset Znacznik czasu Unix resetu limitu
Moknah-Credits-Remaining Twoje pozostałe saldo kredytów

Najczęstsze kody błędów

Kod Typ Opis
400 INVALID_REQUEST Nieprawidłowe parametry lub błędnie sformatowany JSON
401 UNAUTHORIZED Nieprawidłowy lub brakujący klucz API
402 INSUFFICIENT_CREDITS Konto nie ma wystarczającej liczby kredytów
429 RATE_LIMIT_EXCEEDED Zbyt wiele zapytań (HTTP)
4290 CONCURRENT_LIMIT Zbyt wiele aktywnych połączeń (WSS)
500 INTERNAL_SERVER_ERROR Błąd serwera
Dowiedz się więcej

Zobacz stronę Błędy aby uzyskać szczegółowe wskazówki dotyczące obsługi błędów.

Kolejne kroki

Gdy wszystko jest już gotowe, poznaj dostępne punkty końcowe:

POST Lista głosów

Pobierz dostępne głosy dla TTS

POST Generuj mowę

Konwertuj tekst na audio

WSS Strumieniowanie mowy

TTS w czasie rzeczywistym przez WebSocket

POST Transkrybuj mowę

Wyodrębnij tekst z pliku audio

WSS Strumieniowanie transkrypcji

STT w czasie rzeczywistym przez WebSocket

Wsparcie API

W razie pytań lub problemów związanych z API skontaktuj się z nami pod adresem api@moknah.io.