Classify

Create Classify Job

Create a classify job.

Classifies a document against a set of rules. Set file_input to a file ID (dfl-...) or parse job ID (pjb-...), and provide either inline configuration with rules or a configuration_id referencing a saved preset.

Each rule has a type (the label to assign) and a description (natural language criteria). The classifier returns the best matching rule with a confidence score.

The job runs asynchronously. Poll GET /classify/{job_id} to check status and retrieve results.

post/api/v2/classify

Query parameters

project_idstring uuid nullable

organization_idstring uuid nullable

Cookies

sessionstring nullable

Request body

configuration_idstring nullable

Saved configuration ID

file_inputstring nullable

File ID or parse job ID to classify

file_idstring nullable

Deprecated: use file_input instead

parse_job_idstring nullable

Deprecated: use file_input instead

transaction_idstring nullable

Idempotency key scoped to the project

Example request

{
  "webhook_configurations": [
    {
      "webhook_url": "https://example.com/webhooks/llamacloud",
      "webhook_headers": {
        "Authorization": "Bearer sk-..."
      },
      "webhook_events": [
        "parse.success",
        "parse.error"
      ],
      "webhook_output_format": "json"
    }
  ],
  "configuration_id": "cfg-11111111-2222-3333-4444-555555555555",
  "configuration": {
    "rules": [
      {
        "type": "invoice",
        "description": "contains invoice number, line items, and total amount"
      }
    ],
    "parsing_configuration": {
      "lang": "en",
      "target_pages": "1,3,5-7",
      "max_pages": 10
    }
  },
  "file_input": "dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "file_id": "dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "parse_job_id": "pjb-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "transaction_id": "tx-unique-idempotency-key"
}

Response

Successful Response

created_atstring date-time nullable

Creation datetime

updated_atstring date-time nullable

Update datetime

file_inputstring required

ID of the input file or parse job

project_idstring required

Project this job belongs to

user_idstring required

User who created this job

status'PENDING' | 'RUNNING' | 'COMPLETED' | 'FAILED' required

Current job status: PENDING, RUNNING, COMPLETED, or FAILED

document_input_type'url' | 'file_id' | 'parse_job_id' required

Whether the input was a file or parse job (FILE or PARSE_JOB)

error_messagestring nullable

Error message if job failed

configuration_idstring nullable

Product configuration ID

transaction_idstring nullable

Idempotency key

parse_job_idstring nullable

Associated parse job ID

Example response

{
  "configuration": {
    "rules": [
      {
        "type": "invoice",
        "description": "contains invoice number, line items, and total amount"
      }
    ],
    "parsing_configuration": {
      "lang": "en",
      "target_pages": "1,3,5-7",
      "max_pages": 10
    }
  }
}

Changes

Changed in 3 of the 33 revisions of this API.17

Jun 9, 2026b17341164de92See the full diff
- ○
  added the optional property detail/items/ctx to the response with the 422 status
  response-optional-property-added
- ○
  added the optional property detail/items/input to the response with the 422 status
  response-optional-property-added
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 4, 2026d40e17e17bd11See the full diff
- ○
  added the new optional request property webhook_configurations
  new-optional-request-property
Apr 1, 20267e0726654d2214See the full diff
- ▲
  removed the required property document_input_value from the response with the 200 status
  response-required-property-removed
- ○
  added the new optional request property file_input
  new-optional-request-property
- ○
  request property file_id deprecated
  request-property-deprecated
- ○
  request property parse_job_id deprecated
  request-property-deprecated
- ○
  added the required property file_input to the response with the 200 status
  response-required-property-added

Full history