API Reference

Classify

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get Classify Job

classify.get(strjob_id, ClassifyGetParams**kwargs) -> ClassifyGetResponse

GET/api/v2/classify/{job_id}

Get a classify job by ID.

Returns the job status, configuration, and classify result when complete. The result includes the matched document type, confidence score, and reasoning.

ParametersExpand Collapse

job_id: str

organization_id: Optional[str]

project_id: Optional[str]

ReturnsExpand Collapse

class ClassifyGetResponse: …

Response for a classify job.

id: str

Unique identifier

configuration: ClassifyConfiguration

Classify configuration used for this job

rules: List[Rule]

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

description: str

Natural language criteria for matching this rule

maxLength2000

minLength10

type: str

Document type to assign when rule matches

maxLength50

minLength1

mode: Optional[Literal["FAST"]]

Classify execution mode

parsing_configuration: Optional[ParsingConfiguration]

Parsing configuration for classify jobs.

lang: Optional[str]

ISO 639-1 language code for the document

max_pages: Optional[int]

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

minimum1

target_pages: Optional[str]

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

document_input_type: Literal["url", "file_id", "parse_job_id"]

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

One of the following:

"url"

"file_id"

"parse_job_id"

file_input: str

ID of the input file or parse job

project_id: str

Project this job belongs to

status: Literal["PENDING", "RUNNING", "COMPLETED", "FAILED"]

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

One of the following:

"PENDING"

"RUNNING"

"COMPLETED"

"FAILED"

user_id: str

User who created this job

configuration_id: Optional[str]

Product configuration ID

created_at: Optional[datetime]

Creation datetime

formatdate-time

error_message: Optional[str]

Error message if job failed

parse_job_id: Optional[str]

Associated parse job ID

result: Optional[ClassifyResult]

Result of classifying a document.

confidence: float

Confidence score between 0.0 and 1.0

maximum1

minimum0

reasoning: str

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

type: Optional[str]

Matched rule type, or null if no rule matched

transaction_id: Optional[str]

Idempotency key

updated_at: Optional[datetime]

Update datetime

formatdate-time

Get Classify Job

Python

HTTP

TypeScript

Python

Java

Go

CLI Tool

import os
from llama_cloud import LlamaCloud

client = LlamaCloud(
    api_key=os.environ.get("LLAMA_CLOUD_API_KEY"),  # This is the default and can be omitted
)
classify = client.classify.get(
    job_id="job_id",
)
print(classify.id)

200 example

{
  "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"
}

Returns Examples

200 example

{
  "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"
}