Skip to main content

Quality Evaluator API Reference 1.0.0

The Quality Evaluator API uses LLMs to automatically assess translation quality against requirements you define — in plain language, not fixed rule sets. It scales the kind of review a human linguist would do: check tone, terminology, formatting, and custom requirements across any volume of segments. This All version includes every endpoint the service has ever exposed, including deprecated ones kept here for reference. If you’re starting a new integration, use the Latest version instead.

Two ways to define quality requirements

  • Content Group–driven evaluation (current) — Quality requirements are managed as Style Guide Rules attached to a Content Group. Link evaluation to the Content Group and the API resolves its active Rules into AI Checks automatically — no separate profile to create or keep in sync.
  • AI Checks & Quality Profiles (deprecated) — Create individual AI Checks, group up to 3 into a Quality Profile, and evaluate segments by referencing the profile’s UID directly. These endpoints are deprecated and will be removed on October 12, 2026.

Key Features

  • Content Group integration: Quality requirements stay in sync with Style Guide Rules without manual profile maintenance
  • AI Checks: Checks defined in natural language (e.g., “Translation must not use Yoda-style speech”), resolved from Rules or authored directly
  • Quality Profiles: Group up to 3 AI Checks into a reusable profile (deprecated)
  • Analytics: Track evaluation metrics and AI unit consumption over time

Base URLs

The Quality Evaluator API is available in multiple regions:
RegionBase URL
EUhttps://eu.phrase.com/quality-evaluator
UShttps://us.phrase.com/quality-evaluator

Quick Start

Content Group–driven evaluation (current)
  1. Attach Style Guide Rules to your Content Group (with AI Check support enabled)
  2. Evaluate segments by referencing the Content Group — checks are resolved automatically
# Example: Evaluate segments against a Content Group's resolved AI Checks
curl -X POST "https://eu.phrase.com/quality-evaluator/v3/evaluation" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "contentGroupId": "cg-abc123",
    "segments": [
      {
        "id": "seg-1",
        "source": "Hello, world!",
        "target": "Hallo, Welt!"
      }
    ],
    "sourceLocaleCode": "en_us",
    "targetLocaleCode": "de_de"
  }'
AI Checks & Quality Profiles (deprecated, removed October 12, 2026)
  1. Create an AI Check with your quality requirements
  2. Create a Quality Profile containing your AI Checks
  3. Evaluate segments by referencing the profile
# Example: Evaluate segments using a Quality Profile
curl -X POST "https://eu.phrase.com/quality-evaluator/v2/evaluation" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "qualityProfileUid": "your-profile-uid",
    "segments": [
      {
        "source": "Hello, world!",
        "target": "Hallo, Welt!"
      }
    ],
    "sourceLocaleCode": "en_us",
    "targetLocaleCode": "de_de"
  }'