Skip to main content
POST
Evaluate segments

Authorizations

Authorization
string
header
required

Use a Bearer token obtained from Phrase Platform authentication. See the Authentication guide for details on how to obtain a token.

Headers

Content-Type
string
required

Indicates media type of the resource. Always application/json.

Example:

"application/json"

Body

application/json

Request to evaluate translation segments using the AI Checks resolved from a Content Group.

contentGroupId
string
required

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

segments
object[]
required

Segments to evaluate. Each segment id, when provided, must be unique within the request; duplicate ids result in a 400 Bad Request.

Required array length: 1 - 200 elements
sourceLocaleCode
string<locale>
required

Locale code compatible with the Phrase locale format. Case-insensitive; accepts _ or - as the separator (for example en_us, en-US, de_de). Responses use lowercase codes.

Example:

"en_us"

targetLocaleCode
string<locale>
required

Locale code compatible with the Phrase locale format. Case-insensitive; accepts _ or - as the separator (for example en_us, en-US, de_de). Responses use lowercase codes.

Example:

"en_us"

Response

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

Evaluation results for the v3 endpoint.

segments
object[]
required

Evaluated segments with all check results nested per segment.

contentGroupId
string

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

evaluationHistoryId
string | null

Identifier of this evaluation run. Quote it when contacting support. null if the run could not be recorded.