> ## 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. # Create a glossary > Create a new glossary in the organization. Its `scope`, approval workflow, and QA severities can be set here or updated later. Add languages and terms in follow-up calls. ## OpenAPI ````yaml /openapi/textsetu.json post /orgs/{orgId}/glossaries 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: /orgs/{orgId}/glossaries: post: tags: - Glossary summary: Create a glossary description: >- Create a new glossary in the organization. Its `scope`, approval workflow, and QA severities can be set here or updated later. Add languages and terms in follow-up calls. parameters: - name: orgId in: path required: true schema: type: string description: Organization id (UUID) or id-embedded path slug. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 100 description: >- Human-readable glossary name, unique within the organization. examples: - Brand Terms description: description: Optional summary of what this glossary covers. examples: - >- Approved product and brand terminology for all UI surfaces. type: string maxLength: 500 scope: description: >- Which projects the glossary applies to: `all` projects in the org, or only `selected` ones assigned to it. Defaults to `all`. examples: - all type: string enum: - all - selected approvalRequired: description: >- When true, term translations from non-approvers are stored as proposals until approved. examples: - false type: boolean approvalBypassAdmins: description: >- When true, org/glossary admins' edits are auto-approved even while approval is required. examples: - true type: boolean qaTermConsistency: description: >- Severity when a required term is missing from a translation: `off`, `warning`, or `error`. See the [quality checks guide](/docs/guides/quality-checks). examples: - warning type: string enum: - 'off' - warning - error qaForbiddenTerms: description: >- Severity when a forbidden or deprecated term is used: `off`, `warning`, or `error`. examples: - error type: string enum: - 'off' - warning - error required: - name responses: '201': description: The created glossary. content: application/json: schema: type: object required: - success - data properties: success: type: boolean const: true data: type: object properties: glossary: type: object properties: id: type: string description: Unique glossary id (UUID). examples: - a1b2c3d4-0000-4000-8000-000000000010 orgId: type: string description: Id of the organization that owns the glossary. examples: - org_5a4b3c2d name: type: string description: Human-readable glossary name. examples: - Brand Terms description: anyOf: - type: string - type: 'null' description: Optional summary of what the glossary covers. examples: - >- Approved product and brand terminology for all UI surfaces. scope: type: string description: >- Project applicability: `all` projects in the org, or only `selected` assigned ones. examples: - all approvalRequired: type: boolean description: >- True when term translations require approval before they apply. examples: - false approvalBypassAdmins: type: boolean description: >- True when admins' edits are auto-approved while approval is required. examples: - true qaTermConsistency: type: string description: >- Severity for missing-required-term issues: `off`, `warning`, or `error`. examples: - warning qaForbiddenTerms: type: string description: >- Severity for forbidden/deprecated-term issues: `off`, `warning`, or `error`. examples: - error createdAt: type: string description: Creation timestamp (ISO 8601). examples: - '2026-01-15T09:24:00.000Z' updatedAt: type: string description: Last-update timestamp (ISO 8601). examples: - '2026-02-02T14:05:00.000Z' required: - id - orgId - name - description - scope - approvalRequired - approvalBypassAdmins - qaTermConsistency - qaForbiddenTerms - createdAt - updatedAt additionalProperties: false required: - glossary additionalProperties: false '500': description: The glossary could not be created. 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`. ````