V2
Parse

Cancel Parse Job

Changed on

Cancel a running parse 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/parse/{job_id}/cancel

Request

  • Base URL: https://api.cloud.llamaindex.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.cloud.llamaindex.ai/api/v2/parse/{job_id}/cancel
  • Auth: HTTP bearer

Path parameters

job_idstring required

Query parameters

project_idstring uuid nullable
organization_idstring uuid nullable

Cookies

sessionstring nullable

Response

Successful Response

user_metadataobject nullable

Key/value tags associated with this job.

idstring required

Unique parse job identifier

created_atstring date-time nullable

Creation datetime

updated_atstring date-time nullable

Update datetime

project_idstring required

Project this job belongs to

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

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

error_messagestring nullable

Error details when status is FAILED

namestring nullable

Optional display name for this parse job

tierstring nullable

Parsing tier used for this job

Example response

{
  "user_metadata": {
    "owner": "jerry",
    "team": "research"
  },
  "id": "pjb-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "project_id": "prj-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "name": "Q4 Financial Report",
  "tier": "fast",
  "usage": {
    "credits": 30
  }
}

Changes

  • a38b684f8e1bRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 614771991b52Revision changes
    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status