---
title: "Lookup"
method: POST
path: "/translations/lookup"
tags: ["Translation"]
---

# Lookup

`POST /translations/lookup`

Translates a phrase in plain text or a BCM fragment containing a single segment. The translated content will be returned as a BCM [fragment](https://developers.rws.com/languagecloud-api-docs/api/bcm/Sdl.Core.Bcm.BcmModel.Fragment.html) or [term](https://developers.rws.com/languagecloud-api-docs/api/bcm/Sdl.Core.Bcm.BcmModel.Skeleton.Term.html). 

 For detailed concepts and examples see the [Translation API](../docs/translations/Translations.html) page.

## Query parameters

- `fields` string

## Headers

- `Authorization` string, required
- `X-LC-Tenant` string, required

## Request body

- TranslationSearchRequest
  - `input` TranslationLookupInputRequest, required — The translation input.
    - `content` string, required — A plain text phrase or a BCM fragment with a single segment serialized as JSON string.
    - `contentType` 'text' | 'bcmFragment', required — The content type.
  - `languageDirection` LanguageDirectionGeneralRequest, required — The language directions model used for creating or updating a resource.
    - `sourceLanguage` SourceLanguageRequest
      - `languageCode` string, required — The language code.
    - `targetLanguage` TargetLanguageRequest
      - `languageCode` string, required — The language code.
  - `definition` TranslationDefinition, required
    - `translationEngineId` string, required — The translation engine identifier.
  - `settings` TranslationSearchSettings
    - `translationMemory` TranslationSearchSettingsTm
      - `minimumMatchValue` integer — This is the degree of match that must exist between a source document segment and a translation memory segment in order for the segment translation to be offered as a match. The default is 70%, but you can set a value between 30% and 100%. The selected value is inclusive, meaning that matches with your exact selected value are also included in translation results.
      - `penalties` TranslationSearchTMPenalties
        - `standardPenalties` TranslationSearchStandardPenalties
          - `missingFormatting` integer
          - `differentFormatting` integer
          - `multipleTranslations` integer
          - `autoLocalization` integer
          - `textReplacement` integer
          - `alignment` integer
          - `characterWidthDifference` integer
        - `translationUnitStatusPenalties` TranslationSearchUnitStatusPenalties — The penalties to apply depending on the status of the translation unit.
          - `translated` integer
          - `translationRejected` integer
          - `translationApproved` integer
          - `signOffRejected` integer
          - `signOff` integer
          - `notTranslated` integer
          - `draft` integer

## Response `200`

OK

- TranslationSearchResponse
  - `translations` Translation[], required — Translations from different resource origins such as `TM`. The origin information is found in the BCM fragment.
    - `translationProposal` string, required — The translation content serialized as JSON. BCM fragment for `TM` and `MT`. BCM term for `TB`.
    - `resourceType` 'TM' | 'MT' | 'TB', required — The translation resource type
    - `sourceLocation` TranslationSourceLocation[]
      - `start` integer
      - `length` integer
  - `appliedResourcesStatus` TranslationAppliedResourceStatus[]
    - `resourceId` string — <div style="display:inline; float:right; color:#008080; margin-top:-23px; font-size:11px">default</div>The resource identifier.
    - `resourceType` 'TM' | 'MT' | 'TB' — The translation resource type
    - `status` 'successful' | 'unsuccessful' — <div style="display:inline; float:right; color:#008080; margin-top:-23px; font-size:11px">default</div>The status of the applied resource.
    - `message` string — A message describing the applied resource.
    - `translationErrors` TranslationErrorDetailResponse[] — Details of possible errors.
      - `name` string — <div style="display:inline; float:right; color:#008080; margin-top:-23px; font-size:11px">default</div><div style="display: inline;"></div>
      - `code` string — <div style="display:inline; float:right; color:#008080; margin-top:-23px; font-size:11px">default</div><div style="display: inline;"></div>
      - `value` string — <div style="display:inline; float:right; color:#008080; margin-top:-23px; font-size:11px">default</div><div style="display: inline;"></div>

## Other responses

- `400` — Error codes: * "empty": Empty value for variable mentioned in the "name" field on the error response. * "invalid": Invalid input mentioned in the "name" field on the error response.
- `401` — The user could not be identified.
- `403` — Unauthorized to use translation engine.
- `404` — Error codes: * "notFound": - translation engine not found.

---

[API](https://skmtc.net/rws/apis/trados-cloud-platform-api.md) · [All operations](https://skmtc.net/rws/apis/trados-cloud-platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rws/trados-cloud-platform-api/revisions/d42dac7c28a3/schema)