> ## 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.

# Concordance search

> Free-text search across the project's translation memories — *how has this word or phrase been translated before?* — returning the full segments that contain it.

This answers what `/tm/matches` cannot: fuzzy matching scores WHOLE segment similarity, so a segment that merely contains your phrase but is otherwise different scores far below threshold and never surfaces. Use `searchIn: "target"` to find where a translated term was used. See the [translation memory guide](/docs/guides/translation-memory).



## OpenAPI

````yaml /openapi/textsetu.json post /projects/{projectId}/tm/search
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
    <token>` 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}/tm/search:
    post:
      tags:
        - Translation Memory
      summary: Concordance search
      description: >-
        Free-text search across the project's translation memories — *how has
        this word or phrase been translated before?* — returning the full
        segments that contain it.


        This answers what `/tm/matches` cannot: fuzzy matching scores WHOLE
        segment similarity, so a segment that merely contains your phrase but is
        otherwise different scores far below threshold and never surfaces. Use
        `searchIn: "target"` to find where a translated term was used. See the
        [translation memory guide](/docs/guides/translation-memory).
      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:
                query:
                  type: string
                  minLength: 1
                  maxLength: 1000
                  description: The word or phrase to search for within stored TM segments.
                  examples:
                    - welcome
                languageCodes:
                  description: >-
                    Restrict returned translations to these language codes (all
                    languages if omitted).
                  examples:
                    - - fr
                      - de
                  maxItems: 50
                  type: array
                  items:
                    type: string
                    minLength: 1
                searchIn:
                  default: both
                  description: >-
                    Where to match: `source` (source text only), `target`
                    (translated text only), or `both`.
                  examples:
                    - both
                  type: string
                  enum:
                    - source
                    - target
                    - both
                page:
                  default: 1
                  description: 1-based page number.
                  examples:
                    - 1
                  type: integer
                  minimum: 1
                limit:
                  default: 50
                  description: Results per page, 1–200.
                  examples:
                    - 50
                  type: integer
                  minimum: 1
                  maximum: 200
              required:
                - query
      responses:
        '200':
          description: A paginated list of matching TM segments with their translations.
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                properties:
                  success:
                    type: boolean
                    const: true
                  data:
                    type: object
                    properties:
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            entryId:
                              type: string
                              description: >-
                                Id of the TM entry containing the matched
                                segment.
                              examples:
                                - tme_7b1c4d90
                            sourceText:
                              type: string
                              description: >-
                                The full source segment that contains your
                                search term.
                              examples:
                                - Welcome to your account
                            context:
                              anyOf:
                                - type: string
                                - type: 'null'
                              description: >-
                                Optional context note stored with the entry, or
                                `null` if none.
                              examples:
                                - Shown after login
                            tmId:
                              type: string
                              description: >-
                                Id of the translation memory the entry belongs
                                to.
                              examples:
                                - tm_3f2a9b1c
                            tmName:
                              type: string
                              description: Human-readable name of that translation memory.
                              examples:
                                - Marketing TM
                            translations:
                              type: array
                              items:
                                type: object
                                properties:
                                  languageCode:
                                    type: string
                                    description: >-
                                      BCP-47 language code this translation is
                                      written in.
                                    examples:
                                      - fr
                                  value:
                                    type: string
                                    description: >-
                                      The translated text stored for this
                                      language.
                                    examples:
                                      - Bienvenue
                                  status:
                                    type: string
                                    description: >-
                                      Review state of the translation:
                                      `approved`, `pending_review`, or `draft`.
                                    examples:
                                      - approved
                                required:
                                  - languageCode
                                  - value
                                  - status
                                additionalProperties: false
                              description: >-
                                The entry's translations, filtered to the
                                requested languages.
                          required:
                            - entryId
                            - sourceText
                            - context
                            - tmId
                            - tmName
                            - translations
                          additionalProperties: false
                      total:
                        type: integer
                      page:
                        type: integer
                      limit:
                        type: integer
                    required:
                      - items
                      - total
                      - page
                      - limit
                    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`.

````