API ReferenceExtraction JobsCreate Job

Create Job

POST /api/v1/jobs/

Create an extraction job for an uploaded document. The job is processed asynchronously — poll the Retrieve Job endpoint to check for completion.

Authentication

Requires an API key with jobs:write scope. Pass via the X-API-Key header.

Request

Content type: application/json

Body Parameters

FieldTypeRequiredDescription
document_idstring (UUID)YesThe ID of the uploaded document to extract data from.

The document must already exist in your organization. Use the Upload Document endpoint first if needed.

Response

Status: 201 Created

{
  "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "status": "pending",
  "document_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "created_at": "2026-03-16T12:00:00Z",
  "updated_at": "2026-03-16T12:00:00Z"
}

Response Fields

FieldTypeDescription
idstring (UUID)Unique identifier for the extraction job.
statusstringCurrent job status. Starts as pending.
document_idstring (UUID)The document being processed.
created_atstring (ISO 8601)Timestamp when the job was created.
updated_atstring (ISO 8601)Timestamp when the job was last updated.

Errors

StatusDescription
400Invalid or missing document_id.
401Missing or invalid API key.
403API key does not have jobs:write scope.
404Document not found in your organization.

Code Examples

curl -X POST https://api.parsifyhq.com/api/v1/jobs/ \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"document_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"}'