GET /v1/jobs/{batch_id}
https://api.voygr.tech/v1/jobs/{batch_id}
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
| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
batch_id | path | required | string |
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.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
batch_id | string | required | |
type | string | null | optional | Example: "validate", "enrich" |
status | string | required | one of queued, running, completed, failed, cancelled |
created_at | string | required | |
started_at | string | null | optional | |
completed_at | string | null | optional | |
total_items | integer | required | |
progress | JobProgress | null | optional | |
eta_seconds | integer | null | optional | |
eta_completion_at | string | null | optional | |
results | JobResults | null | optional | |
error | string | null | optional | |
error_code | string | null | optional |
HTTPValidationError
Type: object
| Field | Type | Required | Description and constraints |
|---|---|---|---|
detail | array of ValidationError | optional |
JobProgress
Type: object
| Field | Type | Required | Description and constraints |
|---|---|---|---|
processed | integer | required | |
succeeded | integer | required | |
failed | integer | required |
JobResults
Type: object
| Field | Type | Required | Description and constraints |
|---|---|---|---|
format | string | optional | constant jsonl.gz; default jsonl.gz |
total_items | integer | required | |
files | array of JobResultFile | required |
ValidationError
Type: object
| Field | Type | Required | Description and constraints |
|---|---|---|---|
loc | array of (string | integer) | required | |
msg | string | required | |
type | string | required | |
input | any | optional | |
ctx | object | optional |
JobResultFile
Type: object
| Field | Type | Required | Description and constraints |
|---|---|---|---|
url | string | required | |
size_bytes | integer | required | |
sha256 | string | required | |
expires_at | string | required |
On this page
