Tolgee Octri Demo
POST/v2/projects/{projectId}/suggest/translation-memory

Get suggestions from translation memory

Returns translation memory suggestions for a project and target language. Supply targetLanguageId and either a stored keyId or base text to find matching suggestions; results are always sorted by similarity. Use page and size to paginate the results.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

4 parameters · 6 body fields
projectIdintegerrequired
The int64 identifier of the project to search.
pageintegeroptional
Zero-based page index. Defaults to 0 when omitted and must be 0 or greater.
Default:0
sizeintegeroptional
Number of results per page. Defaults to 20 when omitted and must be at least 1.
Default:20
sortarray<string>optional
Sorting criteria are not supported; results are always sorted by similarity, so this parameter does not change the order.

Translation memory suggestion criteria. Provide the required target language and the key or base text to search against.

baseTextstringoptional
Text value of base translation. Useful, when base translation is not stored yet.
isPluralbooleanoptional
Whether base text is plural. This value is ignored if baseText is null.
keyIdintegeroptional
Key Id to get results for. Use when key is stored already.
pluralbooleanoptional
Write-only flag indicating whether the base text is plural.
servicesarray<string>optional
List of services to use. If null, then all enabled services are used.
targetLanguageIdintegerrequired
The int64 identifier of the target language.

5 status codes
200Returns a paginated response containing translation memory suggestions and page metadata, including the page number, size, total elements, and total pages.
_embeddedobjectoptional
pageobjectoptional
400Returned when the request is invalid, such as when a required value is missing or a parameter or body field fails validation.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
401Returned when the request is not authenticated.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
403Returned when the authenticated user is not permitted to access this resource.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
404Returned when the project or a referenced resource cannot be found.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional

Error handling

A 400 is returned when the request is invalid; a 401 indicates missing or invalid authentication, and a 403 indicates access is denied. A 404 is returned when the project or a referenced resource cannot be found. targetLanguageId is required, size must be at least 1, and services accepts only GOOGLE, AWS, DEEPL, AZURE, BAIDU, or PROMPT.