Skip to content

Get batch job status and results

GET /v1/jobs/{batch_id}

https://api.voygr.tech/v1/jobs/{batch_id}

Open in playground

Overview

Status, progress and ETA for a submitted job. When status is completed, the response carries results.files[] with a presigned download URL (expires in ~15 minutes - poll again for a fresh one). The file is gzipped JSONL: one result line per input row, in input order.

Authentication

  • API key in header X-API-Key: Your customer API key (pk_live_...), sent on every request. Self-serve at https://api.voygr.tech/checkout.

Parameters

NameLocationRequiredTypeDescription and constraints
batch_idpathrequiredstring

Responses

200

Successful Response

application/json

Schema: ValidationJobStatus

422

Validation Error

application/json

Schema: HTTPValidationError

Schemas

ValidationJobStatus

Type: object

Status and results for a submitted job.

FieldTypeRequiredDescription and constraints
batch_idstringrequired
typestring | nulloptionalExample: "validate", "enrich"
statusstringrequiredone of queued, running, completed, failed, cancelled
created_atstringrequired
started_atstring | nulloptional
completed_atstring | nulloptional
total_itemsintegerrequired
progressJobProgress | nulloptional
eta_secondsinteger | nulloptional
eta_completion_atstring | nulloptional
resultsJobResults | nulloptional
errorstring | nulloptional
error_codestring | nulloptional

HTTPValidationError

Type: object

FieldTypeRequiredDescription and constraints
detailarray of ValidationErroroptional

JobProgress

Type: object

FieldTypeRequiredDescription and constraints
processedintegerrequired
succeededintegerrequired
failedintegerrequired

JobResults

Type: object

FieldTypeRequiredDescription and constraints
formatstringoptionalconstant jsonl.gz; default jsonl.gz
total_itemsintegerrequired
filesarray of JobResultFilerequired

ValidationError

Type: object

FieldTypeRequiredDescription and constraints
locarray of (string | integer)required
msgstringrequired
typestringrequired
inputanyoptional
ctxobjectoptional

JobResultFile

Type: object

FieldTypeRequiredDescription and constraints
urlstringrequired
size_bytesintegerrequired
sha256stringrequired
expires_atstringrequired