Skip to main content

Create Job

Create and run an extraction job with a schema and optional document set. Returns a job ID for polling progress and retrieving results.

POST/v1/jobs

Response

Response fields (201 Created)

idstringJob UUID.
statusstringAlways "pending" immediately after creation.
messagestringHuman-readable confirmation message.
links.selfstringURL to poll for job status.
links.resultsstringURL to retrieve result rows once complete.

Response (201 Created)

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "pending",
  "message": "Job created and queued for processing.",
  "links": {
    "self": "/v1/jobs/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "results": "/v1/jobs/a1b2c3d4-e5f6-7890-abcd-ef1234567890/results"
  }
}

Errors

Error responses

400bad_requestNo completed documents found for your organization, or request body is invalid.
401unauthorizedMissing or invalid API key.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.

Related

List Jobs
Get Job