Skip to main content
POST
/
v3
/
evaluation
Evaluate segments
curl --request POST \
  --url https://eu.phrase.com/quality-evaluator/v3/evaluation \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "contentGroupId": "cg-abc123",
  "segments": [
    {
      "id": "segment-1",
      "source": "Hello, world!",
      "target": "Hallo, Welt!"
    }
  ],
  "sourceLocaleCode": "en_us",
  "targetLocaleCode": "de_de"
}
'
{
  "contentGroupId": "cg-abc123",
  "segments": [
    {
      "id": "segment-1",
      "source": "Hello, world!",
      "target": "Hallo, Welt!",
      "results": [
        {
          "type": "AI_CHECK",
          "ruleUid": "rule-abc123",
          "evaluation": {
            "isValid": true,
            "explanation": "The translation uses standard German sentence structure."
          }
        }
      ]
    }
  ]
}

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
Example:

"application/json"

Body

application/json

Request to evaluate translation segments using 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's id is required and must be unique within the request.

Required array length: 1 - 200 elements
​
sourceLocaleCode
string
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:

"en_us"

​
targetLocaleCode
string
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:

"en_us"

Response

Evaluation completed successfully. Returns evaluated segments with 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.