Create Validation Run
Create a validation run comparing a job against a ground-truth dataset. Measures per-document and per-field extraction accuracy.
POST
/v1/validation/runsResponse
Response fields (201 Created)
idstringValidation run UUID.
namestringRun name.
statusstringInitial status, always pending.
dataspace_run_idstring | nullUUID of the job run being validated.
golden_sample_idstringUUID of the ground-truth dataset.
accuracynumber | nullAlways null until the run completes.
total_comparisonsinteger | nullAlways null until the run completes.
created_atstringISO 8601 creation timestamp.
completed_atstring | nullAlways null until the run completes.
linksobjectRelated resource URLs (self, results).
Response (201 Created)
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Q1 Invoice accuracy check",
"status": "pending",
"dataspace_run_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"golden_sample_id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
"accuracy": null,
"total_comparisons": null,
"created_at": "2024-09-14T10:32:00.000Z",
"completed_at": null,
"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.
404not_foundJob run or ground-truth dataset not found, or they do not belong to your organization.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.