For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
  • Get Started
    • Introduction
    • Quickstart
    • Authentication
  • API Reference
      • GETList Dictionary Entries
      • POSTCreate Dictionary Entry
      • GETSearch Dictionary Entries
      • GETList Dictionary Languages
      • POSTSuggest Pronunciation
      • PUTUpdate Dictionary Entry
      • DELDelete Dictionary Entry
  • Python SDK
    • Install
    • Usage
    • Errors
  • CLI
    • Overview
LogoLogo
API Referencedictionary

Suggest Pronunciation

POST
/api/v1/dictionary/suggest-pronunciation
POST
/api/v1/dictionary/suggest-pronunciation
$curl -X POST https://api.onepin.ai/api/v1/dictionary/suggest-pronunciation \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "word": "quokka",
>  "language": "en-US"
>}'
1{
2  "data": {
3    "pronunciation": "kwok-uh",
4    "ipa": "None"
5  },
6  "meta": {
7    "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
8    "timestamp": "2024-01-15T09:30:00Z"
9  }
10}
Return a deterministic FE-parity pronunciation fallback. ``language`` is reserved for future per-locale rules; ``ipa`` is reserved for a future generator and is always ``None`` in this version. Workspace scoping is enforced via ``get_current_workspace`` even though the response is workspace-independent today: this keeps all ``/api/v1/`` endpoints uniform (see CLAUDE.md §Workspace Scoping) and leaves room for per-workspace dictionary overrides when the generator lands.
Was this page helpful?
Previous

Update Dictionary Entry

Next
Built with

Return a deterministic FE-parity pronunciation fallback.

language is reserved for future per-locale rules; ipa is reserved for a future generator and is always None in this version.

Workspace scoping is enforced via get_current_workspace even though the response is workspace-independent today: this keeps all /api/v1/ endpoints uniform (see CLAUDE.md §Workspace Scoping) and leaves room for per-workspace dictionary overrides when the generator lands.

Authentication

AuthorizationBearer
Clerk JWT token
OR
AuthorizationBearer

Onepin live API key (op_live_...). Test and public keys are reserved in Phase 1.

Headers

X-Workspace-Idstring or nullOptional

Request

This endpoint expects an object.
wordstringRequired1-255 characters
languagestringRequiredformat: "^[a-zA-Z]{2,3}(-[a-zA-Z0-9]{2,4})?$"2-10 characters

Response

Successful Response
dataobject
metaobject

Errors

422
Unprocessable Entity Error