API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Classify

Create Classify Job

client.Classify.New(ctx, params) (*ClassifyNewResponse, error)

POST/api/v2/classify

List Classify Jobs

client.Classify.List(ctx, query) (*PaginatedCursor[ClassifyListResponse], error)

GET/api/v2/classify

Get Classify Job

client.Classify.Get(ctx, jobID, query) (*ClassifyGetResponse, error)

GET/api/v2/classify/{job_id}

ModelsExpand Collapse

type ClassifyConfiguration struct{…}

Configuration for a classify job.

Rules []ClassifyConfigurationRule

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

Description string

Natural language criteria for matching this rule

maxLength2000

minLength10

Type string

Document type to assign when rule matches

maxLength50

minLength1

Mode ClassifyConfigurationModeOptional

Classify execution mode

ParsingConfiguration ClassifyConfigurationParsingConfigurationOptional

Parsing configuration for classify jobs.

Lang stringOptional

ISO 639-1 language code for the document

MaxPages int64Optional

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

minimum1

TargetPages stringOptional

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

type ClassifyCreateRequest struct{…}

Request to create a classify job.

Configuration ClassifyConfigurationOptional

Configuration for a classify job.

Rules []ClassifyConfigurationRule

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

Description string

Natural language criteria for matching this rule

maxLength2000

minLength10

Type string

Document type to assign when rule matches

maxLength50

minLength1

Mode ClassifyConfigurationModeOptional

Classify execution mode

ParsingConfiguration ClassifyConfigurationParsingConfigurationOptional

Parsing configuration for classify jobs.

Lang stringOptional

ISO 639-1 language code for the document

MaxPages int64Optional

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

minimum1

TargetPages stringOptional

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

ConfigurationID stringOptional

Saved configuration ID

DeprecatedFileID stringOptional

Deprecated: use file_input instead

FileInput stringOptional

File ID or parse job ID to classify

maxLength200

DeprecatedParseJobID stringOptional

Deprecated: use file_input instead

TransactionID stringOptional

Idempotency key scoped to the project. Reusing a key returns the original job; the new request body is ignored.

maxLength255

WebhookConfigurations []ClassifyCreateRequestWebhookConfigurationOptional

Outbound webhook endpoints to notify on job status changes

WebhookEvents []stringOptional

Events to subscribe to (e.g. ‘parse.success’, ‘extract.error’). If null, all events are delivered.

One of the following:

const ClassifyCreateRequestWebhookConfigurationWebhookEventClassifyCancelled ClassifyCreateRequestWebhookConfigurationWebhookEvent = "classify.cancelled"

const ClassifyCreateRequestWebhookConfigurationWebhookEventClassifyError ClassifyCreateRequestWebhookConfigurationWebhookEvent = "classify.error"

const ClassifyCreateRequestWebhookConfigurationWebhookEventClassifyPartialSuccess ClassifyCreateRequestWebhookConfigurationWebhookEvent = "classify.partial_success"

const ClassifyCreateRequestWebhookConfigurationWebhookEventClassifyPending ClassifyCreateRequestWebhookConfigurationWebhookEvent = "classify.pending"

const ClassifyCreateRequestWebhookConfigurationWebhookEventClassifyRunning ClassifyCreateRequestWebhookConfigurationWebhookEvent = "classify.running"

const ClassifyCreateRequestWebhookConfigurationWebhookEventClassifySuccess ClassifyCreateRequestWebhookConfigurationWebhookEvent = "classify.success"

const ClassifyCreateRequestWebhookConfigurationWebhookEventExtractCancelled ClassifyCreateRequestWebhookConfigurationWebhookEvent = "extract.cancelled"

const ClassifyCreateRequestWebhookConfigurationWebhookEventExtractError ClassifyCreateRequestWebhookConfigurationWebhookEvent = "extract.error"

const ClassifyCreateRequestWebhookConfigurationWebhookEventExtractPartialSuccess ClassifyCreateRequestWebhookConfigurationWebhookEvent = "extract.partial_success"

const ClassifyCreateRequestWebhookConfigurationWebhookEventExtractPending ClassifyCreateRequestWebhookConfigurationWebhookEvent = "extract.pending"

const ClassifyCreateRequestWebhookConfigurationWebhookEventExtractSuccess ClassifyCreateRequestWebhookConfigurationWebhookEvent = "extract.success"

const ClassifyCreateRequestWebhookConfigurationWebhookEventParseCancelled ClassifyCreateRequestWebhookConfigurationWebhookEvent = "parse.cancelled"

const ClassifyCreateRequestWebhookConfigurationWebhookEventParseError ClassifyCreateRequestWebhookConfigurationWebhookEvent = "parse.error"

const ClassifyCreateRequestWebhookConfigurationWebhookEventParsePartialSuccess ClassifyCreateRequestWebhookConfigurationWebhookEvent = "parse.partial_success"

const ClassifyCreateRequestWebhookConfigurationWebhookEventParsePending ClassifyCreateRequestWebhookConfigurationWebhookEvent = "parse.pending"

const ClassifyCreateRequestWebhookConfigurationWebhookEventParseRunning ClassifyCreateRequestWebhookConfigurationWebhookEvent = "parse.running"

const ClassifyCreateRequestWebhookConfigurationWebhookEventParseSuccess ClassifyCreateRequestWebhookConfigurationWebhookEvent = "parse.success"

const ClassifyCreateRequestWebhookConfigurationWebhookEventSheetsCancelled ClassifyCreateRequestWebhookConfigurationWebhookEvent = "sheets.cancelled"

const ClassifyCreateRequestWebhookConfigurationWebhookEventSheetsError ClassifyCreateRequestWebhookConfigurationWebhookEvent = "sheets.error"

const ClassifyCreateRequestWebhookConfigurationWebhookEventSheetsPartialSuccess ClassifyCreateRequestWebhookConfigurationWebhookEvent = "sheets.partial_success"

const ClassifyCreateRequestWebhookConfigurationWebhookEventSheetsPending ClassifyCreateRequestWebhookConfigurationWebhookEvent = "sheets.pending"

const ClassifyCreateRequestWebhookConfigurationWebhookEventSheetsSuccess ClassifyCreateRequestWebhookConfigurationWebhookEvent = "sheets.success"

const ClassifyCreateRequestWebhookConfigurationWebhookEventSplitCancelled ClassifyCreateRequestWebhookConfigurationWebhookEvent = "split.cancelled"

const ClassifyCreateRequestWebhookConfigurationWebhookEventSplitError ClassifyCreateRequestWebhookConfigurationWebhookEvent = "split.error"

const ClassifyCreateRequestWebhookConfigurationWebhookEventSplitPending ClassifyCreateRequestWebhookConfigurationWebhookEvent = "split.pending"

const ClassifyCreateRequestWebhookConfigurationWebhookEventSplitProcessing ClassifyCreateRequestWebhookConfigurationWebhookEvent = "split.processing"

const ClassifyCreateRequestWebhookConfigurationWebhookEventSplitSuccess ClassifyCreateRequestWebhookConfigurationWebhookEvent = "split.success"

const ClassifyCreateRequestWebhookConfigurationWebhookEventUnmappedEvent ClassifyCreateRequestWebhookConfigurationWebhookEvent = "unmapped_event"

WebhookHeaders map[string, string]Optional

Custom HTTP headers sent with each webhook request (e.g. auth tokens)

WebhookOutputFormat stringOptional

Response format sent to the webhook: ‘string’ (default) or ‘json’

WebhookSigningSecret stringOptional

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.

WebhookURL stringOptional

URL to receive webhook POST notifications

type ClassifyResult struct{…}

Result of classifying a document.

Confidence float64

Confidence score between 0.0 and 1.0

maximum1

minimum0

Reasoning string

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

Type string

Matched rule type, or null if no rule matched