Skip to main content

List Validation Runs

List validation runs that compare extraction results against ground-truth datasets. Requires read scope.

GET/v1/validation/runs

Response

Response fields

dataarrayArray of validation run objects (up to 100, ordered by created_at descending).
data[].idstringValidation run UUID.
data[].namestringHuman-readable run name.
data[].statusstringRun status: pending, running, completed, or failed.
data[].dataspace_run_idstring | nullUUID of the job run being validated.
data[].golden_sample_idstringUUID of the ground-truth dataset.
data[].accuracynumber | nullOverall accuracy score (0–1) once the run completes.
data[].total_comparisonsinteger | nullTotal number of field comparisons made.
data[].created_atstringISO 8601 creation timestamp.
data[].completed_atstring | nullISO 8601 completion timestamp.
data[].linksobjectRelated resource URLs (self, results).

Response

{
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Q1 Invoice accuracy check",
      "status": "completed",
      "dataspace_run_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "golden_sample_id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "accuracy": 0.94,
      "total_comparisons": 250,
      "created_at": "2024-09-14T10:32:00.000Z",
      "completed_at": "2024-09-14T10:35:00.000Z",
      "links": {
        "self": "/v1/validation/runs/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "results": "/v1/validation/runs/a1b2c3d4-e5f6-7890-abcd-ef1234567890/results"
      }
    }
  ]
}

Errors

Error responses

401unauthorizedMissing or invalid API key.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.