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(ParsingCancelParamsparameters, CancellationTokencancellationToken = default)

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 parameters

required string jobID

string? organizationID

string? projectID

ReturnsExpand Collapse

class ParsingCancelResponse:

A parse job.

required string ID

Unique parse job identifier

required string ProjectID

Project this job belongs to

required 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

DateTimeOffset? CreatedAt

Creation datetime

formatdate-time

string? ErrorMessage

Error details when status is FAILED

string? Name

Optional display name for this parse job

string? Tier

Parsing tier used for this job

DateTimeOffset? UpdatedAt

Update datetime

formatdate-time

Usage? Usage

Usage recorded against a job.

Double? Credits

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

IReadOnlyDictionary<string, string>? UserMetadata

Key/value tags associated with this job.

Cancel Parse Job

C#

HTTP

TypeScript

Python

Go

Java

C#

CLI Tool

ParsingCancelParams parameters = new() { JobID = "job_id" };

var response = await client.Parsing.Cancel(parameters);

Console.WriteLine(response);

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