Skip to main content

Get / Delete Validation Run

Get validation run detail with accuracy summary or delete a run. Supports GET (read scope) and DELETE (write scope) on the same path.

GET/v1/validation/runs/{id}

Response

Response fields (GET)

idstringValidation run UUID.
namestringRun name.
statusstringRun status: pending, running, completed, or failed.
dataspace_run_idstring | nullUUID of the job run being validated.
golden_sample_idstringUUID of the ground-truth dataset.
accuracynumber | nullOverall accuracy score (0–1) once completed.
total_comparisonsinteger | nullTotal field comparisons made.
created_atstringISO 8601 creation timestamp.
completed_atstring | nullISO 8601 completion timestamp.
linksobjectRelated resource URLs (self, results).

Response (GET)

{
  "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"
  }
}

Response (DELETE)

{
  "deleted": true
}

Errors

Error responses

401unauthorizedMissing or invalid API key.
404not_foundValidation run not found or does not belong to your organization.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.