API Reference

Parsing

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Cancel Parse Job

client.parsing.cancel(stringjobID, ParsingCancelParams { organization_id, project_id } params?, RequestOptionsoptions?): ParsingCancelResponse { id, project_id, status, 7 more }

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.

ParametersExpand Collapse

jobID: string

params: ParsingCancelParams { organization_id, project_id }

organization_id?: string | null

project_id?: string | null

ReturnsExpand Collapse

ParsingCancelResponse { id, project_id, status, 7 more }

A parse job.

id: string

Unique parse job identifier

project_id: string

Project this job belongs to

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

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

One of the following:

"CANCELLED"

"COMPLETED"

"FAILED"

"PENDING"

"RUNNING"

created_at?: string | null

Creation datetime

formatdate-time

error_message?: string | null

Error details when status is FAILED

name?: string | null

Optional display name for this parse job

tier?: string | null

Parsing tier used for this job

updated_at?: string | null

Update datetime

formatdate-time

usage?: Usage | null

Usage recorded against a job.

credits?: number | null

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

user_metadata?: Record<string, string> | null

Key/value tags associated with this job.

Cancel Parse Job

TypeScript

HTTP

TypeScript

Python

Go

Java

C#

CLI Tool

import LlamaCloud from '@llamaindex/llama-cloud';

const client = new LlamaCloud({
  apiKey: process.env['LLAMA_CLOUD_API_KEY'], // This is the default and can be omitted
});

const response = await client.parsing.cancel('job_id');

console.log(response.id);

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"
  }
}