Skip to main content

Get Job

Get job status, progress percentage, current phase, document counts, grid statistics, and estimated completion time for an extraction job.

Retrieve the current status and progress of a specific extraction job. Use this endpoint to poll for completion after creating a job. The grid_stats field provides real-time cell fill rates, and current_phase indicates which pipeline phase is actively executing.

GET/v1/jobs/:id

Response

Response fields

idstringJob UUID.
namestring | nullOptional human-readable job name.
statusstringJob status: pending, processing, complete, failed.
progressinteger | nullFill-rate progress percentage (0–100). Only set while status is processing.
estimated_seconds_remaininginteger | nullEstimated seconds until completion. Currently always null.
schemaobject | nullSchema used for this job: { id, name }.
document_countintegerTotal number of documents in the job.
completed_documentsintegerNumber of documents fully processed.
grid_statsobject | nullCell-level stats: { total_cells, filled, empty, fill_rate }.
current_phasestring | nullCurrent pipeline phase (e.g. phase_2_execute).
errorobject | nullError details when status is failed: { code, message }.
created_atstringISO 8601 creation timestamp.
started_atstring | nullISO 8601 start timestamp.
completed_atstring | nullISO 8601 completion timestamp.
linksobjectRelated resource URLs (self, cancel if active, dashboard).

Response

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "Q4 Invoice Run",
  "status": "processing",
  "progress": 65,
  "estimated_seconds_remaining": null,
  "schema": { "id": "sch_uuid_1", "name": "Invoice" },
  "document_count": 48,
  "completed_documents": 31,
  "grid_stats": {
    "total_cells": 2016,
    "filled": 1310,
    "empty": 706,
    "fill_rate": 0.65
  },
  "current_phase": "phase_2_execute",
  "created_at": "2024-09-14T10:32:00.000Z",
  "started_at": "2024-09-14T10:32:05.000Z",
  "completed_at": null,
  "links": {
    "self": "/v1/jobs/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "cancel": "/v1/jobs/a1b2c3d4-e5f6-7890-abcd-ef1234567890/cancel",
    "dashboard": "https://app.talonic.com/jobs/a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
}

This endpoint is typically used in a polling loop after POST /v1/jobs. Watch current_phase to track pipeline progression through phase_1_resolve, phase_2_execute, phase_3_resolve, and phase_4_transform. The grid_stats.fill_rate value increases as each phase completes, giving you a real-time quality signal before the job reaches complete status.

Errors

Error responses

400validation_errorInvalid job ID format. Must be a UUID.
401unauthorizedMissing or invalid API key.
404not_foundNo job with this ID exists for your organization.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.