Dokumentacja API
ClearPronounce API v1 — zapis wymowy i generowanie dystraktorów
Autoryzacja
Wszystkie zapytania API wymagają klucza API przesyłanego w nagłówku X-API-Key.
Limit zapytań: 100 zapytań/minutę na klucz API (konfigurowalny).
X-API-Key: TWÓJ_KLUCZ_API
Endpointy
POST
/api/v1/respell
Zamień angielskie słowo na zapis polskimi literami. Zwraca IPA, zapis wymowy, oznaczenia akcentu i informacje o nowych dźwiękach.
Treść zapytania
| Pole | Typ | Opis |
|---|
word | string | Angielskie słowo do zapisu (wymagane) |
Odpowiedź
{
"word": "think",
"ipa": "θ ɪ ŋ k",
"respelling": "fynk",
"respelling_stressed": "<strong>FYNK</strong>",
"already_pronounceable": false,
"unlocked_by": "θ;ɪ;ŋ"
}
POST
/api/v1/distractors
Wygeneruj rundę gry z 4 opcjami: 1 poprawna odpowiedź + 3 dystraktory oparte na interferencji L1.
Treść zapytania
| Pole | Typ | Opis |
|---|
word | string | Angielskie słowo (wymagane) |
Odpowiedź
{
"word": "think",
"ipa": "θ ɪ ŋ k",
"correct": "fynk",
"options": ["tynk", "fynk", "synk", "fink"],
"correct_index": 1
}
Kody błędów
| Kod | Znaczenie |
|---|
401 | Brak lub nieprawidłowy klucz API |
404 | Słowo nie znalezione w słowniku |
429 | Przekroczono limit zapytań |
422 | Nieprawidłowa treść zapytania |