DEdeepl
QualityEvaluation

Poll for the evaluation result

Changed on

Returns the current state of a quality evaluation. While the evaluation is in progress the response carries only status information; once it completes, the response carries the full report.

Evaluations are requested with enable_quality_evaluation on POST /v2/document. There is no public endpoint for starting one.

get/v1/quality-evaluations/{job_id}

Request

  • Base URL
    https://api.deepl.com
  • URL
    https://api.deepl.com/v1/quality-evaluations/{job_id}
  • Auth
    API key in header Authorization

Path parameters

job_idstring required
Example:04DE5AD98A02647D83285A36021911C6

The unique ID of the quality evaluation, returned as quality_evaluation_job_id when the document was uploaded for translation.

Response

Polling result. The response shape depends on the status field. done carries the full report; error carries error details.

OR

Example response

{
  "job_id": "04DE5AD98A02647D83285A36021911C6",
  "status": "done",
  "segments": [
    {
      "segment_score": 38.5,
      "source": "Our Q3 revenue came in 5% above forecast.",
      "target": "Unser Q3-Umsatz lag 5 % unter der Prognose.",
      "applied_glossary_term_pairs": [
        {
          "source_term": "forecast",
          "target_term": "Prognose",
          "ranges": [
            {
              "start": 23,
              "end": 31
            }
          ]
        }
      ],
      "errors": [
        {
          "type": "Accuracy",
          "sub_type": "Mistranslation",
          "severity": "Critical",
          "explanation": "The source says revenue was '5% above forecast' but the translation says '5 % unter der Prognose' (5% below forecast). This completely reverses the meaning and has financial implications.",
          "source_spans": [
            {
              "start": 23,
              "end": 31
            }
          ],
          "target_spans": [
            {
              "start": 23,
              "end": 31
            }
          ]
        }
      ]
    }
  ]
}

Changes