API Reference

Parsing

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Cancel Parse Job

ParsingCancelResponse parsing().cancel(ParsingCancelParamsparams = ParsingCancelParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

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

ParsingCancelParams params

Optional<String> jobId

Optional<String> organizationId

Optional<String> projectId

ReturnsExpand Collapse

class ParsingCancelResponse:

A parse job.

String id

Unique parse job identifier

String projectId

Project this job belongs to

Status status

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

One of the following:

CANCELLED("CANCELLED")

COMPLETED("COMPLETED")

FAILED("FAILED")

PENDING("PENDING")

RUNNING("RUNNING")

Optional<LocalDateTime> createdAt

Creation datetime

formatdate-time

Optional<String> errorMessage

Error details when status is FAILED

Optional<String> name

Optional display name for this parse job

Optional<String> tier

Parsing tier used for this job

Optional<LocalDateTime> updatedAt

Update datetime

formatdate-time

Optional<Usage> usage

Usage recorded against a job.

Optional<Double> credits

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

Optional<UserMetadata> userMetadata

Key/value tags associated with this job.

Cancel Parse Job

Java

HTTP

TypeScript

Python

Go

Java

C#

CLI Tool

package ai.llamaindex.llamacloud.example;

import ai.llamaindex.llamacloud.client.LlamaCloudClient;
import ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;
import ai.llamaindex.llamacloud.models.parsing.ParsingCancelParams;
import ai.llamaindex.llamacloud.models.parsing.ParsingCancelResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        LlamaCloudClient client = LlamaCloudOkHttpClient.fromEnv();

        ParsingCancelResponse response = client.parsing().cancel("job_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"
  }
}