Jobs & Batches

Create and queue a new job

Start a new grid-based job that fills a user schema from a set of documents. Provide a schema_id and, optionally, the specific document_ids to run against. If document_ids is omitted or empty, all completed documents for the customer are used.

post/v1/jobs

Request

  • Base URL: https://api.talonic.com
  • URL: https://api.talonic.com/v1/jobs
  • Auth: HTTP bearer

Request body

schema_idstring uuid required

User schema UUID to run this job against.

document_idsstring[]

Optional list of document UUIDs to process. If omitted or empty, all completed documents for the authenticated customer are used.

namestring nullable

Optional human-readable job name.

Example request

{
  "schema_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "document_ids": [
    "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  ],
  "name": "Q1 Invoice Processing"
}

Response

Job created and queued for processing (alias of 201).

idstring uuid required

The newly created job's UUID.

status'pending' required

The job always starts in pending state.

messagestring

Example response

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

Changes

No recorded changes to this operation across all 1 revision of this API.