Search translation memory (sync)

Overview

• Searches a single translation memory using the primary TM scoring pipeline. The endpoint always returns up to 15 SearchTMResponseDto entries ordered by score.

Modes

• Standard segment search (default): normalize text, leverage penalties, thresholds, tag metadata, and context. This is the behavior when phraseQuery=true(default). The service calls the downstream /search endpoint with wildcard=true to allow combined exact/wildcard candidates in one pass.
• Legacy phrase-only mode: set phraseQuery=false to disable the wildcard branch (wildcard=false, exactIfQuotes=false, combinedExact=false). Use when you need strict normalized matches without wildcard processing.

Request parameters

• query (required): search text. If trimQuery=true (default) leading/trailing whitespace is removed before sending to TM service.
• sourceLang (required) and optional targetLangs: locales are normalized to BCP-47. When targetLangs is omitted the backend queries all TM targets.
• previousSegment / nextSegment: optional context strings; when provided, the backend raises 101% matches that align with the surrounding segments.
• tagMetadata: serialized inline tags; improves scoring and avoids dropping tag pairs.
• trimQuery: default true. Set to false to preserve leading/trailing spaces (rare).
• phraseQuery: default true. Controls whether wildcard/phrase helpers are enabled (see “Modes”).

Scoring & ordering

• Backend computes grossScore (raw similarity) and score (penalty-adjusted). 101% matches retain their priority even after penalties.
• Ordering priority (per downstream service): score DESC, grossScore DESC, context match priority DESC, segment key ASC, TM priority ASC, timestamp DESC, TU id DESC.
• Numeric replacements or uppercase normalization are not performed here (replaceFigures=false, modifyTransText=false in this controller).

Limits & behavior

• Returns maximum 15 matches; there is no offset or totalFoundCount.
• Threshold is fixed to 0, so all results above penalties are returned until limit.
• Multiple target locales per TM are not supported, mirroring backend validation.
• Logical operators (AND/OR/NOT) and wildcard expressions in query are interpreted only when phraseQuery=true enables the wildcard path.

Context & caching notes

• Downstream service may consult its 60-second cache for identical search inputs (including context and penalties). Freshly imported matches might appear with a short delay if cached results are reused.
• If previous/next segments are omitted the search still runs, but 101% context boosts cannot trigger.

Error handling

• Invalid locales, blank query, or an inaccessible TM ID return 400/403.
• Backend may throw when multiple target locales are submitted for a single TM; the controller surfaces that error unchanged.

POST /api2/v1/transMemories/{transMemoryUid}/search

Search translation memory (sync)

cURL

curl --request POST \
  --url https://cloud.memsource.com/web/api2/v1/transMemories/{transMemoryUid}/search \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "sourceLang": "<string>",
  "nextSegment": "<string>",
  "phraseQuery": true,
  "previousSegment": "<string>",
  "tagMetadata": [
    {
      "content": "<string>",
      "id": "<string>",
      "transAttributes": "<string>",
      "type": "<string>"
    }
  ],
  "targetLangs": [
    "<string>"
  ],
  "trimQuery": true
}
'

200

{
  "searchResults": [
    {
      "grossScore": 123,
      "score": 123,
      "segmentId": "<string>",
      "source": {
        "client": {
          "id": 123,
          "name": "<string>"
        },
        "createdAt": 123,
        "createdBy": {
          "email": "<string>",
          "firstName": "<string>",
          "id": "<string>",
          "lastName": "<string>",
          "uid": "<string>",
          "userName": "<string>"
        },
        "domain": {
          "id": 123,
          "name": "<string>"
        },
        "filename": "<string>",
        "id": "<string>",
        "key": "<string>",
        "lang": "<string>",
        "modifiedAt": 123,
        "modifiedBy": {
          "email": "<string>",
          "firstName": "<string>",
          "id": "<string>",
          "lastName": "<string>",
          "uid": "<string>",
          "userName": "<string>"
        },
        "nextSegment": "<string>",
        "previousSegment": "<string>",
        "project": {
          "id": 123,
          "name": "<string>",
          "uid": "<string>"
        },
        "rtl": true,
        "subDomain": {
          "id": 123,
          "name": "<string>"
        },
        "tagMetadata": [
          {
            "content": "<string>",
            "id": "<string>",
            "transAttributes": "<string>",
            "type": "<string>"
          }
        ],
        "text": "<string>"
      },
      "subSegment": true,
      "transMemory": {
        "id": "<string>",
        "name": "<string>",
        "reverse": true,
        "uid": "<string>"
      },
      "translations": [
        {
          "client": {
            "id": 123,
            "name": "<string>"
          },
          "createdAt": 123,
          "createdBy": {
            "email": "<string>",
            "firstName": "<string>",
            "id": "<string>",
            "lastName": "<string>",
            "uid": "<string>",
            "userName": "<string>"
          },
          "domain": {
            "id": 123,
            "name": "<string>"
          },
          "filename": "<string>",
          "id": "<string>",
          "key": "<string>",
          "lang": "<string>",
          "modifiedAt": 123,
          "modifiedBy": {
            "email": "<string>",
            "firstName": "<string>",
            "id": "<string>",
            "lastName": "<string>",
            "uid": "<string>",
            "userName": "<string>"
          },
          "nextSegment": "<string>",
          "previousSegment": "<string>",
          "project": {
            "id": 123,
            "name": "<string>",
            "uid": "<string>"
          },
          "rtl": true,
          "subDomain": {
            "id": 123,
            "name": "<string>"
          },
          "tagMetadata": [
            {
              "content": "<string>",
              "id": "<string>",
              "transAttributes": "<string>",
              "type": "<string>"
            }
          ],
          "text": "<string>"
        }
      ]
    }
  ]
}

Authorizations

ApiTokenOAuth2

Authorization · string · header · required

Get a token from auth/login endpoint and then pass it in the Authorization HTTP header in every subsequent API call. For more information visit our help center.

Path Parameters

transMemoryUid · string · required

Body

application/json

query · string · required

sourceLang · string · required

nextSegment · string

phraseQuery · boolean

Return both wildcard and exact search results. Default: true

previousSegment · string

tagMetadata · object[]

Show child attributes

targetLangs · string[]

trimQuery · boolean

Remove leading and trailing whitespace from query. Default: true

Response

200

application/json

successful operation

searchResults · object[]

Show child attributes