Search Dictionary Entries

GET

/api/v1/dictionary/search

GET

/api/v1/dictionary/search

$ curl -G https://api.onepin.ai/api/v1/dictionary/search \
>      -H "X-Workspace-Id: workspace_12345" \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d search=hello \
>      -d sort=uses_count \
>      -d order=desc \
>      -d offset=0 \
>      -d limit=10 \
>      -d language=en-us \
>      -d language=fr-fr

1 {
2   "data": [
3     {
4       "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
5       "word": "hello",
6       "method": "spelled",
7       "language": "en-us",
8       "uses_count": 1523,
9       "created_at": "2024-01-15T09:30:00Z",
10       "updated_at": "2024-04-10T11:45:00Z",
11       "description": "A greeting or expression of goodwill.",
12       "pronunciation": "həˈloʊ",
13       "audio_url": "https://audio.onepin.ai/pronunciations/hello_us.mp3",
14       "ipa": "həˈloʊ",
15       "created_by": "a3bb189e-8bf9-3888-9912-ace4e6543002"
16     }
17   ],
18   "meta": {
19     "request_id": "req_7f8e9d6c-1234-4a56-b789-0a1b2c3d4e5f",
20     "timestamp": "2024-04-27T14:00:00Z"
21   },
22   "pagination": {
23     "limit": 10,
24     "next": "https://api.onepin.ai/api/v1/dictionary/search?search=hello&offset=10&limit=10",
25     "prev": null
26   }
27 }

Cross-language search over dictionary entries.

Authentication

AuthorizationBearer

Clerk JWT token

AuthorizationBearer

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

Query parameters

searchstringRequired1-200 characters

sortenumOptionalDefaults to created_at

Allowed values:

orderenumOptionalDefaults to desc

Allowed values:

offsetintegerOptional>=0Defaults to 0

limitintegerOptional1-50Defaults to 20

languagelist of enums or nullOptional

Repeat for OR, e.g. ?language=en-us&language=ko-kr

Response

Successful Response

datalist of objects

metaobject

paginationobject

Errors

422

Unprocessable Entity Error

Authentication

Headers

Query parameters

Response

Errors