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

List Dictionary Entries

GET
/api/v1/dictionary
GET
/api/v1/dictionary
$curl -G https://api.onepin.ai/api/v1/dictionary \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d language=de-de
1{
2  "data": [
3    {
4      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
5      "word": "serendipity",
6      "method": "spelled",
7      "language": "en-us",
8      "uses_count": 42,
9      "created_at": "2024-01-15T09:30:00Z",
10      "updated_at": "2024-04-10T11:45:00Z",
11      "description": "The occurrence of events by chance in a happy or beneficial way.",
12      "pronunciation": "ser-en-DIP-uh-tee",
13      "audio_url": "https://audio.onepin.ai/serendipity.mp3",
14      "ipa": "ˌsɛrənˈdɪpɪti",
15      "created_by": "d290f1ee-6c54-4b01-90e6-d701748f0851"
16    }
17  ],
18  "meta": {
19    "request_id": "7b9f8a2e-3c4d-4f1a-9b2e-1a2b3c4d5e6f",
20    "timestamp": "2024-04-27T14:00:00Z"
21  },
22  "pagination": {
23    "limit": 20,
24    "next": "https://api.onepin.ai/api/v1/dictionary?offset=20&limit=20&language=en-us",
25    "prev": null
26  }
27}
List dictionary entries for a single language in the current workspace.
Was this page helpful?
Previous

Create Dictionary Entry

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

Query parameters

methodlist of enums or nullOptional

Repeat for OR, e.g. ?method=spelled&method=recorded

Allowed values:
sortenumOptionalDefaults to created_at
Allowed values:
orderenumOptionalDefaults to desc
Allowed values:
offsetintegerOptional>=0Defaults to 0
limitintegerOptional1-50Defaults to 20
languageenumRequired

BCP-47 language code, e.g. en-us, ko-kr

Response

Successful Response
datalist of objects
metaobject
paginationobject

Errors

422
Unprocessable Entity Error