mcp

Search Keys

Find where a term lives, across a project's source + translation values, in ONE call.

Searches base translation VALUES (source language + every translation, including ICU/CLDR plural sub-forms) and — when include_key_name=true — the key name and description. Results are grouped BY KEY: each item carries a matched_in[] of {language_code, is_source, field, value, offsets}, so the caller sees the term is in e.g. the fr source AND the en translation without a second query.

SCOPE LIMIT (not exhaustive): a11y surface overrides (aria_label, alt_text, screen_reader, plain_language) are NOT included — only base values. Raw regex is not supported in V1 (the query is matched literally); case_sensitive and whole_word refine the match. Read-only, 0 credits.

get/v1/mcp/projects/{project_id}/search-keys

Request

  • Base URL: https://api.sonenta.dev
  • URL: https://api.sonenta.dev/v1/mcp/projects/{project_id}/search-keys
  • Auth: none declared

Path parameters

project_idstring required

Query parameters

querystring required

The term to find. Literal substring (regex-escaped); NOT a regex in V1.

namespacestring nullable

Restrict to one namespace slug.

languagesstring nullable

CSV of BCP-47 codes (e.g. 'fr,en-CA'). Default = ALL (source + every translation language).

case_sensitiveboolean
whole_wordboolean

Match on word boundaries.

include_key_nameboolean

Also search the key NAME and DESCRIPTION (reported with language_code=null).

cursorstring nullable
limitinteger

Page size, in KEYS.

Response

Successful Response

cursor_nextstring nullable required
total_keysinteger required
total_matchesinteger required
truncatedboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.