> ## Documentation Index > Fetch the complete documentation index at: https://docs.textsetu.com/llms.txt > Use this file to discover all available pages before exploring further. # Look up glossary terms > Find the glossary terms that occur in one or more source strings, with their approved translations. Batched: pass every source string and every target language in one call. Each match carries `doNotTranslate`, `caseSensitive` and `usageStatus` (`preferred` / `deprecated` / `forbidden`) so a translator — or an agent generating a translation — can honor terminology rules. **Constraints:** - Returns an empty object when the glossary feature is disabled for the org or the project. - At most 100 source texts and 50 languages per request. - Matching is whole-word where the term has word boundaries, substring otherwise (CJK/Thai). ## OpenAPI ````yaml /openapi/textsetu.json post /projects/{projectId}/glossary/lookup openapi: 3.1.0 info: title: TextSetu API version: 1.2.0 description: >- Public REST API for TextSetu. Authenticate with a Personal Access Token (tsu_pat_…) or a project token (tsu_proj_…) via the `Authorization: Bearer ` header. **Authorization is permission-based.** Every token carries an explicit allow-list of RBAC permission keys (e.g. `translation_read`), and each endpoint declares the permission it requires (`x-permission`). A token's effective access is its underlying authority ∩ its allow-list — a PAT is further bounded by its owner's role-based permissions, so it can only narrow, never exceed, what the owner already has. A project token is bound to a single project. There are no coarse read/write/manage scopes. **Response envelope.** Every endpoint returns `{ "success": true, "data": … }` on success and `{ "success": false, "error": { "code", "message" } }` on failure. **Rate limit.** 600 requests/minute, keyed by token (or by IP when unauthenticated). Exceeding it returns 429 with the standard error envelope. servers: - url: https://api.textsetu.com/api/v1 description: Production - url: /api/v1 description: This server (self-hosted / same-origin) security: - bearerAuth: [] tags: - name: Projects description: >- Read project metadata — settings, key separator, and the approval/branching flags that shape how the other endpoints behave. - name: Languages description: >- List and manage a project's target languages. Each language is referenced by its BCP-47 code; the source language is flagged separately. - name: Translations description: >- Manage a project's translations: create, read, update, and delete translation keys — the identifiers your app looks up, carrying metadata (description, tags, screenshot) — and set the translated value for a key in a given language. Value writes honor the project's approval workflow — non-approver writes land as `pending_review`. - name: Stats description: >- Per-language completeness and approval progress for a project — the numbers behind the dashboard. - name: Import/Export description: >- Bulk-load source files into a project or export the current translations. Supports the same file formats as the web app. - name: Branches description: >- Work on translations in isolation and merge them back. Branch reads/writes mirror the main endpoints but stage changes as a diff until merge. See the [branching guide](/docs/guides/branches). - name: Glossary description: >- Manage term bases — approved terminology and its translations — and check a string against them. See the [glossary guide](/docs/guides/glossary). - name: Translation Memory description: >- Reusable translation stores. Fuzzy-match and concordance-search prior translations to reuse them. See the [translation memory guide](/docs/guides/translation-memory). - name: AI description: >- Machine-translate a project with the org's configured AI engine (brand voice, glossary/TM grounding, and an optional review pass). Runs asynchronously — start a run and poll the returned `jobId`. - name: Webhooks description: >- Get notified when a project's translations change, instead of polling. Register an HTTPS endpoint, subscribe it to the events you care about, and TextSetu POSTs a signed payload whenever one occurs. Payloads follow the [Standard Webhooks](https://www.standardwebhooks.com) spec — verify the `webhook-signature` header with any compatible library. Delivery is at-least-once and unordered, so treat `webhook-id` as an idempotency key. Failed deliveries are retried five times over roughly seven hours, and every attempt is inspectable and replayable via the delivery log. - name: Meta description: Service-level and cross-cutting endpoints. paths: /projects/{projectId}/glossary/lookup: post: tags: - Glossary summary: Look up glossary terms description: >- Find the glossary terms that occur in one or more source strings, with their approved translations. Batched: pass every source string and every target language in one call. Each match carries `doNotTranslate`, `caseSensitive` and `usageStatus` (`preferred` / `deprecated` / `forbidden`) so a translator — or an agent generating a translation — can honor terminology rules. **Constraints:** - Returns an empty object when the glossary feature is disabled for the org or the project. - At most 100 source texts and 50 languages per request. - Matching is whole-word where the term has word boundaries, substring otherwise (CJK/Thai). parameters: - name: projectId in: path required: true schema: type: string description: Project id (UUID) or id-embedded path slug. requestBody: required: true content: application/json: schema: type: object properties: sourceTexts: minItems: 1 maxItems: 100 type: array items: type: string description: >- Source strings to scan for glossary terms (max 100 per call). examples: - - Sign in to continue - Reset your password languageCodes: minItems: 1 maxItems: 50 type: array items: type: string minLength: 1 description: >- Target language codes to return translations for (max 50 per call). examples: - - fr - de required: - sourceTexts - languageCodes responses: '200': description: Terms keyed by source text, then language code content: application/json: schema: type: object required: - success - data properties: success: type: boolean const: true data: type: object properties: matches: type: object propertyNames: type: string additionalProperties: type: object propertyNames: type: string additionalProperties: type: array items: type: object properties: term: type: string description: >- The glossary term found in the source string. examples: - Sign in translation: type: string description: >- The approved translation of the term for the requested language. examples: - Se connecter glossaryId: type: string description: Id of the glossary this term belongs to. examples: - a1b2c3d4-0000-4000-8000-000000000010 glossaryName: type: string description: Name of the glossary this term belongs to. examples: - Brand Terms doNotTranslate: type: boolean description: >- True when the term must be left untranslated (brand/product names). examples: - false caseSensitive: type: boolean description: >- True when matching this term respects its exact casing. examples: - false usageStatus: type: string description: >- Usage rule for the term: `preferred`, `deprecated`, or `forbidden`. examples: - preferred required: - term - translation - glossaryId - glossaryName - doNotTranslate - caseSensitive - usageStatus additionalProperties: false required: - matches additionalProperties: false components: securitySchemes: bearerAuth: type: http scheme: bearer description: >- API token: tsu_pat_… (PAT) or tsu_proj_… (project token). The token's granted RBAC permissions determine access; see each operation's `x-permission`. ````