Create Classify Job

ClassifyJob Classifier.Jobs.Create(, )

POST/api/v1/classifier/jobs

Create a classify job. Experimental: not production-ready and subject to change.

ParametersExpand Collapse

JobCreateParams parameters

required IReadOnlyList<string> fileIds

Body param: The IDs of the files to classify

required IReadOnlyList<ClassifierRule> rules

Body param: The rules to classify the files

required string Description

Natural language description of what to classify. Be specific about the content characteristics that identify this document type.

maxLength2000

minLength10

required string Type

The document type to assign when this rule matches (e.g., ‘invoice’, ‘receipt’, ‘contract’)

maxLength50

minLength1

string? organizationID

Query param

formatuuid

string? projectID

Query param

formatuuid

Mode mode

Body param: The classification mode to use

ClassifyParsingConfiguration parsingConfiguration

Body param: The configuration for the parsing job

IReadOnlyList<WebhookConfiguration> webhookConfigurations

Body param: List of webhook configurations for notifications

IReadOnlyList<string>? WebhookEvents

Events that trigger this webhook. Options: ‘parse.success’ (job completed), ‘parse.error’ (job failed), ‘parse.partial_success’ (some pages failed), ‘parse.pending’, ‘parse.running’, ‘parse.cancelled’. If not specified, webhook fires for all events

IReadOnlyDictionary<string, JsonElement>? WebhookHeaders

Custom HTTP headers to include in webhook requests. Use for authentication tokens or custom routing. Example: {‘Authorization’: ‘Bearer xyz’}

WebhookOutputFormat? WebhookOutputFormat

Format of the webhook payload body. ‘string’ (default) sends the payload as a JSON-encoded string; ‘json’ sends it as a JSON object.

One of the following:

string? WebhookSigningSecret

Shared signing secret used to sign webhook deliveries. When set, each request includes an HMAC-SHA256 signature of the request body in the ‘LC-Signature’ header (value ‘sha256=’). Recompute the HMAC over the raw request body with this secret to verify the delivery is authentic.

string? WebhookUrl

HTTPS URL to receive webhook POST requests. Must be publicly accessible

ReturnsExpand Collapse

class ClassifyJob:

A classify job.

required string ID

Unique identifier

formatuuid

required string ProjectID

The ID of the project

formatuuid

required IReadOnlyList<ClassifierRule> Rules

The rules to classify the files

required string Description

Natural language description of what to classify. Be specific about the content characteristics that identify this document type.

maxLength2000

minLength10

required string Type

The document type to assign when this rule matches (e.g., ‘invoice’, ‘receipt’, ‘contract’)

maxLength50

minLength1

required StatusEnum Status

The status of the classify job

One of the following:

required string UserID

The ID of the user

DateTimeOffset? CreatedAt

Creation datetime

formatdate-time

DateTimeOffset EffectiveAt

string? ErrorMessage

Error message for the latest job attempt, if any.

string? JobRecordID

The job record ID associated with this status, if any.

Mode Mode

The classification mode to use

One of the following:

ClassifyParsingConfiguration ParsingConfiguration

The configuration for the parsing job

ParsingLanguages Lang

The language to parse the files in

One of the following:

Long? MaxPages

The maximum number of pages to parse

IReadOnlyList<Long>? TargetPages

The pages to target for parsing (0-indexed, so first page is at 0)

DateTimeOffset? UpdatedAt

Update datetime

formatdate-time

Create Classify Job

JobCreateParams parameters = new()
{
    FileIds =
    [
        "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
    ],
    Rules =
    [
        new()
        {
            Description = "contains invoice number, line items, and total amount",
            Type = "invoice",
        },
    ],
};

var classifyJob = await client.Classifier.Jobs.Create(parameters);

Console.WriteLine(classifyJob);

{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "project_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "rules": [
    {
      "description": "contains invoice number, line items, and total amount",
      "type": "invoice"
    }
  ],
  "status": "CANCELLED",
  "user_id": "user_id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "effective_at": "2019-12-27T18:11:19.117Z",
  "error_message": "error_message",
  "job_record_id": "job_record_id",
  "mode": "FAST",
  "parsing_configuration": {
    "lang": "abq",
    "max_pages": 0,
    "target_pages": [
      0
    ]
  },
  "updated_at": "2019-12-27T18:11:19.117Z"
}

Returns Examples

{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "project_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "rules": [
    {
      "description": "contains invoice number, line items, and total amount",
      "type": "invoice"
    }
  ],
  "status": "CANCELLED",
  "user_id": "user_id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "effective_at": "2019-12-27T18:11:19.117Z",
  "error_message": "error_message",
  "job_record_id": "job_record_id",
  "mode": "FAST",
  "parsing_configuration": {
    "lang": "abq",
    "max_pages": 0,
    "target_pages": [
      0
    ]
  },
  "updated_at": "2019-12-27T18:11:19.117Z"
}

Note for AI agents: this documentation is built for programmatic access. - Overview of all docs: https://developers.llamaindex.ai/llms.txt - Any page is available as raw Markdown by appending index.md to its URL — e.g. https://developers.llamaindex.ai/llamaparse/parse/getting_started/index.md - Agent-friendly REST search APIs live under https://developers.llamaindex.ai/api/ — search (BM25 full-text), grep (regex), read (fetch a page), and list (browse the doc tree). See https://developers.llamaindex.ai/llms.txt for parameters. - A hosted documentation MCP server is available at https://developers.llamaindex.ai/mcp. If you support MCP, you can ask the user to install it for browsing these docs directly (an alternative to the REST API). Setup: https://developers.llamaindex.ai/for-agents/mcp/ - Other LlamaIndex tooling for agents — the LlamaParse Platform MCP server, agent skills and plugins, and the n8n node — is mapped at https://developers.llamaindex.ai/for-agents/