Sign in
V2
Classify

Cancel Classify Job

Cancel a running classify job.

Stops processing and marks the job as CANCELLED. Returns the updated job. Jobs already in a terminal state (COMPLETED, FAILED, CANCELLED) cannot be cancelled.

post/api/v2/classify/{job_id}/cancel

Path parameters

job_idstring required

Query parameters

project_idstring uuid nullable
organization_idstring uuid nullable

Cookies

sessionstring nullable

Response

Successful Response

created_atstring date-time nullable

Creation datetime

updated_atstring date-time nullable

Update datetime

file_inputstring required

ID of the input file or parse job

project_idstring required

Project this job belongs to

user_idstring required

User who created this job

status'PENDING' | 'RUNNING' | 'COMPLETED' | 'FAILED' required

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

document_input_type'url' | 'file_id' | 'parse_job_id' required

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

error_messagestring nullable

Error message if job failed

configuration_idstring nullable

Product configuration ID

transaction_idstring nullable

Idempotency key

parse_job_idstring nullable

Associated parse job ID

Example response

{
  "configuration": {
    "rules": [
      {
        "type": "invoice",
        "description": "contains invoice number, line items, and total amount"
      }
    ],
    "parsing_configuration": {
      "lang": "en",
      "target_pages": "1,3,5-7",
      "max_pages": 10
    }
  }
}

Changes

Changed in 2 of the 33 revisions of this API.3

  • b17341164de92See the full diff
    • ○

      added the optional property detail/items/ctx to the response with the 422 status

      response-optional-property-added

    • ○

      added the optional property detail/items/input to the response with the 422 status

      response-optional-property-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 1bbc901f8c0d1See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog