API Reference

Parsing

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Cancel Parse Job

POST/api/v2/parse/{job_id}/cancel

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.

Path ParametersExpand Collapse

job_id: string

Query ParametersExpand Collapse

organization_id: optional string

project_id: optional string

Cookie ParametersExpand Collapse

session: optional string

ReturnsExpand Collapse

id: string

Unique parse job identifier

project_id: string

Project this job belongs to

status: "CANCELLED" or "COMPLETED" or "FAILED" or 2 more

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

One of the following:

"CANCELLED"

"COMPLETED"

"FAILED"

"PENDING"

"RUNNING"

created_at: optional string

Creation datetime

formatdate-time

error_message: optional string

Error details when status is FAILED

name: optional string

Optional display name for this parse job

tier: optional string

Parsing tier used for this job

updated_at: optional string

Update datetime

formatdate-time

usage: optional object { credits }

Usage recorded against a job.

credits: optional number

Total credits billed against this job. Null until billing has recorded it.

user_metadata: optional map[string]

Key/value tags associated with this job.

Cancel Parse Job

HTTP

HTTP

TypeScript

Python

Go

Java

C#

CLI Tool

curl https://api.cloud.llamaindex.ai/api/v2/parse/$JOB_ID/cancel \
    -X POST \
    -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"

200 example

{
  "id": "pjb-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "project_id": "prj-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "status": "CANCELLED",
  "created_at": "2019-12-27T18:11:19.117Z",
  "error_message": "error_message",
  "name": "Q4 Financial Report",
  "tier": "fast",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "usage": {
    "credits": 30
  },
  "user_metadata": {
    "owner": "jerry",
    "team": "research"
  }
}

Returns Examples

200 example

{
  "id": "pjb-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "project_id": "prj-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "status": "CANCELLED",
  "created_at": "2019-12-27T18:11:19.117Z",
  "error_message": "error_message",
  "name": "Q4 Financial Report",
  "tier": "fast",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "usage": {
    "credits": 30
  },
  "user_metadata": {
    "owner": "jerry",
    "team": "research"
  }
}