Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26316155742.7 KB
Evaluation

Evaluate segments

Evaluates all segments against the AI Checks resolved from the given Content Group.

When no checks are associated with the Content Group, all segments are returned with an empty results array — no error is raised.

Requires ADMIN or OWNER IDM role.

post/v3/evaluation

Headers

Content-Typestring required
Example:application/json

Request body

contentGroupIdstring required

ID of the Content Group whose AI Checks are used for evaluation.

sourceLocaleCodestring required

Locale code compatible with Phrase locale format. Case-insensitive, supports both underscore and hyphen separators (e.g., en_us, en-US, de_de, fr_fr).

targetLocaleCodestring required

Locale code compatible with Phrase locale format. Case-insensitive, supports both underscore and hyphen separators (e.g., en_us, en-US, de_de, fr_fr).

Example request

{
  "sourceLocaleCode": "en_us",
  "targetLocaleCode": "en_us"
}

Response

Evaluation completed successfully. Returns evaluated segments with per-check results.

contentGroupIdstring

ID of the Content Group whose AI Checks were used for evaluation.