Search Dictionary Entries

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 language=en-us \
     -d language=fr-fr \
     -d limit=10 \
     -d offset=0 \
     -d order=asc \
     -d search=light \
     -d sort=word

{
  "data": [
    {
      "id": "a3f1c9e2-4b7d-4f8a-9c3e-2d5f7b6a1e9c",
      "word": "Light",
      "method": "spelled",
      "language": "en-us",
      "uses_count": 152,
      "created_at": "2023-11-20T14:22:00Z",
      "updated_at": "2024-04-10T08:15:30Z",
      "description": "Refers to the natural agent that stimulates sight and makes things visible.",
      "pronunciation": "lahyt",
      "audio_url": "https://audio.onepin.ai/presigned/light_12345.mp3",
      "ipa": "laɪt",
      "created_by": "d290f1ee-6c54-4b01-90e6-d701748f0851"
    },
    {
      "id": "b7e2d3f4-5c6a-4d8b-9f0e-3a7c8d9b2f1e",
      "word": "Lumière",
      "method": "spelled",
      "language": "fr-fr",
      "uses_count": 87,
      "created_at": "2023-12-05T10:00:00Z",
      "updated_at": "2024-01-15T09:30:00Z",
      "description": "French word for light, used in various contexts including physics and art.",
      "pronunciation": "lym.jɛʁ",
      "audio_url": null,
      "ipa": "lymjɛʁ",
      "created_by": null
    }
  ],
  "meta": {
    "request_id": "req_7890abcdef123456",
    "timestamp": "2024-06-01T12:00:00Z"
  },
  "pagination": {
    "limit": 10,
    "next": "https://api.onepin.ai/api/v1/dictionary/search?search=light&offset=10&limit=10",
    "prev": null
  }
}

Search dictionary entries by word text across one or more locales.

Performs a case-insensitive substring match on the word field. Optionally narrow to one or more BCP-47 locales by repeating ?language= (OR logic). Omitting language searches across all locales in the workspace.

Use GET /dictionary (locale-scoped list) when you want the full entry list for a specific locale; use this endpoint when you need to find how a word is defined across languages or when the user is typing a search query.

Search dictionary entries by word text across one or more locales. Performs a case-insensitive substring match on the `word` field. Optionally narrow to one or more BCP-47 locales by repeating `?language=` (OR logic). Omitting `language` searches across all locales in the workspace. Use `GET /dictionary` (locale-scoped list) when you want the full entry list for a specific locale; use this endpoint when you need to find how a word is defined across languages or when the user is typing a search query.

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

Substring to match against the word field (case-insensitive).

sortenumOptionalDefaults to created_at

Field to sort by.

Allowed values:

orderenumOptionalDefaults to desc

Sort direction.

Allowed values:

offsetintegerOptional>=0Defaults to 0

Zero-based pagination offset.

limitintegerOptional1-50Defaults to 20

Page size (max 50).

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