API Documentation
ClearPronounce API v1 — respell words & generate distractors
Authentication
All API requests require an API key passed in the X-API-Key header.
Rate limit: 100 requests/minute per API key (configurable).
X-API-Key: YOUR_API_KEY
Endpoints
POST
/api/v1/respell
Respell an English word using Polish-style spelling rules. Returns IPA, respelling, stress markup, and unlock info.
Request body
| Field | Type | Description |
word | string | English word to respell (required) |
Response
{
"word": "think",
"ipa": "θ ɪ ŋ k",
"respelling": "fynk",
"respelling_stressed": "<strong>FYNK</strong>",
"already_pronounceable": false,
"unlocked_by": "θ;ɪ;ŋ"
}
POST
/api/v1/distractors
Generate a 4-option game round for a word: 1 correct answer + 3 L1-interference distractors.
Request body
| Field | Type | Description |
word | string | English word (required) |
Response
{
"word": "think",
"ipa": "θ ɪ ŋ k",
"correct": "fynk",
"options": ["tynk", "fynk", "synk", "fink"],
"correct_index": 1
}
Error codes
| Code | Meaning |
401 | Missing or invalid API key |
404 | Word not found in dictionary |
429 | Rate limit exceeded |
422 | Invalid request body |