API Reference

Classify

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List Classify Jobs

ClassifyListPageResponse Classify.List(ClassifyListParams?parameters, CancellationTokencancellationToken = default)

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

ClassifyListParams parameters

string? configurationID

Filter by configuration ID

DateTimeOffset? createdAtOnOrAfter

Include items created at or after this timestamp (inclusive)

formatdate-time

DateTimeOffset? createdAtOnOrBefore

Include items created at or before this timestamp (inclusive)

formatdate-time

IReadOnlyList<string>? jobIds

Filter by specific job IDs

string? organizationID

Long? pageSize

Number of items per page

maximum100

minimum1

string? pageToken

Token for pagination

string? projectID

Status? status

Filter by job status

"COMPLETED"Completed

"FAILED"Failed

"PENDING"Pending

"RUNNING"Running

ReturnsExpand Collapse

class ClassifyListPageResponse:

Response schema for paginated classify job queries.

required IReadOnlyList<ClassifyListResponse> Items

The list of items.

required string ID

Unique identifier

required ClassifyConfiguration Configuration

Classify configuration used for this job

required IReadOnlyList<Rule> Rules

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

required string Description

Natural language criteria for matching this rule

maxLength2000

minLength10

required string Type

Document type to assign when rule matches

maxLength50

minLength1

Mode Mode

Classify execution mode

ParsingConfiguration? ParsingConfiguration

Parsing configuration for classify jobs.

string Lang

ISO 639-1 language code for the document

Long? MaxPages

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

minimum1

string? TargetPages

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

required DocumentInputType DocumentInputType

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

One of the following:

"file_id"FileID

"parse_job_id"ParseJobID

"url"Url

required string FileInput

ID of the input file or parse job

required string ProjectID

Project this job belongs to

required Status Status

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

One of the following:

"COMPLETED"Completed

"FAILED"Failed

"PENDING"Pending

"RUNNING"Running

required string UserID

User who created this job

string? ConfigurationID

Product configuration ID

DateTimeOffset? CreatedAt

Creation datetime

formatdate-time

string? ErrorMessage

Error message if job failed

string? ParseJobID

Associated parse job ID

ClassifyResult? Result

Result of classifying a document.

required Double Confidence

Confidence score between 0.0 and 1.0

maximum1

minimum0

required string Reasoning

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

required string? Type

Matched rule type, or null if no rule matched

string? TransactionID

Idempotency key

DateTimeOffset? UpdatedAt

Update datetime

formatdate-time

string? NextPageToken

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

Long? TotalSize

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

C#

HTTP

TypeScript

Python

Go

Java

C#

CLI Tool

ClassifyListParams parameters = new();

var page = await client.Classify.List(parameters);
await foreach (var item in page.Paginate())
{
    Console.WriteLine(item);
}

200 example

{
  "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": "file_id",
      "file_input": "file_input",
      "project_id": "project_id",
      "status": "COMPLETED",
      "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

200 example

{
  "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": "file_id",
      "file_input": "file_input",
      "project_id": "project_id",
      "status": "COMPLETED",
      "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
}