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

Create Dictionary Entry

POST
/api/v1/dictionary
POST
/api/v1/dictionary
$curl -X POST https://api.onepin.ai/api/v1/dictionary \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "word": "serendipity",
>  "method": "spelled",
>  "language": "en"
>}'
1{
2  "data": {
3    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4    "word": "serendipity",
5    "method": "spelled",
6    "language": "en",
7    "uses_count": 42,
8    "created_at": "2024-01-15T09:30:00Z",
9    "updated_at": "2024-01-15T09:30:00Z",
10    "description": "The occurrence of events by chance in a happy or beneficial way.",
11    "pronunciation": "ser-en-DIP-uh-tee",
12    "audio_url": "https://cdn.onepin.ai/audio/serendipity.mp3",
13    "ipa": "ˌsɛrənˈdɪpɪti",
14    "created_by": "d290f1ee-6c54-4b01-90e6-d701748f0851"
15  },
16  "meta": {
17    "request_id": "7b9f1c2e-3d4a-4f8b-9a2e-1f2b3c4d5e6f",
18    "timestamp": "2024-01-15T09:30:00Z"
19  }
20}
Create a new dictionary entry in the current workspace.
Was this page helpful?
Previous

Search Dictionary Entries

Next
Built with

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
methodenumRequired
Allowed values:
languagestringRequiredformat: "^[a-zA-Z]{2,3}(-[a-zA-Z0-9]{2,4})?$"1-10 characters
descriptionstring or nullOptional<=500 characters
pronunciationstring or nullOptional<=500 characters
upload_idstring or nullOptionalformat: "uuid"
ipastring or nullOptional<=500 characters

User-provided IPA transcription. Persisted as-is. Auto-generation via phonemizer/LLM is a POD-256 follow-up.

Response

Successful Response
dataobject
metaobject

Errors

422
Unprocessable Entity Error