List Classify Jobs

$ llamacloud-prod classify list

GET/api/v2/classify

List classify jobs with optional filtering and pagination.

Filter by status, configuration_id, specific job_ids, or creation date range.

ParametersExpand Collapse

--configuration-id: optional string

Filter by configuration ID

--created-at-on-or-after: optional string

Include items created at or after this timestamp (inclusive)

--created-at-on-or-before: optional string

Include items created at or before this timestamp (inclusive)

--job-id: optional array of string

Filter by specific job IDs

--organization-id: optional string

--page-size: optional number

Number of items per page

--page-token: optional string

Token for pagination

--project-id: optional string

--status: optional "PENDING" or "RUNNING" or "COMPLETED" or "FAILED"

Filter by job status

ReturnsExpand Collapse

ClassifyV2JobQueryResponse: object { items, next_page_token, total_size }

Response schema for paginated classify job queries.

items: array of object { id, configuration, document_input_type, 11 more }

The list of items.

id: string

Unique identifier

configuration: object { rules, mode, parsing_configuration }

Classify configuration used for this job

rules: array of object { description, type }

Classify rules to evaluate against the document (at least one required)

description: string

Natural language criteria for matching this rule

type: string

Document type to assign when rule matches

mode: optional "FAST"

Classify execution mode

"FAST"

parsing_configuration: optional object { lang, max_pages, target_pages }

Parsing configuration for classify jobs.

lang: optional string

ISO 639-1 language code for the document

max_pages: optional number

Maximum number of pages to process. Omit for no limit.

target_pages: optional string

Comma-separated page numbers or ranges to process (1-based). Omit to process all pages.

document_input_type: "url" or "file_id" or "parse_job_id"

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

"url"

"file_id"

"parse_job_id"

file_input: string

ID of the input file or parse job

project_id: string

Project this job belongs to

status: "PENDING" or "RUNNING" or "COMPLETED" or "FAILED"

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

"PENDING"

"RUNNING"

"COMPLETED"

"FAILED"

user_id: string

User who created this job

configuration_id: optional string

Product configuration ID

created_at: optional string

Creation datetime

error_message: optional string

Error message if job failed

parse_job_id: optional string

Associated parse job ID

result: optional object { confidence, reasoning, type }

Result of classifying a document.

confidence: number

Confidence score between 0.0 and 1.0

reasoning: string

Why the document matched (or didn't match) the returned rule

type: string

Matched rule type, or null if no rule matched

transaction_id: optional string

Idempotency key

updated_at: optional string

Update datetime

next_page_token: optional string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

total_size: optional number

The total number of items available. This is only populated when specifically requested. The value may be an estimate and can be used for display purposes only.

List Classify Jobs

llamacloud-prod classify list \
  --api-key 'My API Key'

{
  "items": [
    {
      "id": "id",
      "configuration": {
        "rules": [
          {
            "description": "contains invoice number, line items, and total amount",
            "type": "invoice"
          }
        ],
        "mode": "FAST",
        "parsing_configuration": {
          "lang": "en",
          "max_pages": 10,
          "target_pages": "1,3,5-7"
        }
      },
      "document_input_type": "url",
      "file_input": "file_input",
      "project_id": "project_id",
      "status": "PENDING",
      "user_id": "user_id",
      "configuration_id": "configuration_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "error_message": "error_message",
      "parse_job_id": "parse_job_id",
      "result": {
        "confidence": 0,
        "reasoning": "reasoning",
        "type": "type"
      },
      "transaction_id": "transaction_id",
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}

Returns Examples

{
  "items": [
    {
      "id": "id",
      "configuration": {
        "rules": [
          {
            "description": "contains invoice number, line items, and total amount",
            "type": "invoice"
          }
        ],
        "mode": "FAST",
        "parsing_configuration": {
          "lang": "en",
          "max_pages": 10,
          "target_pages": "1,3,5-7"
        }
      },
      "document_input_type": "url",
      "file_input": "file_input",
      "project_id": "project_id",
      "status": "PENDING",
      "user_id": "user_id",
      "configuration_id": "configuration_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "error_message": "error_message",
      "parse_job_id": "parse_job_id",
      "result": {
        "confidence": 0,
        "reasoning": "reasoning",
        "type": "type"
      },
      "transaction_id": "transaction_id",
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}