API Reference

Parsing

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List Parse Jobs

ParsingListPageResponse Parsing.List(ParsingListParams?parameters, CancellationTokencancellationToken = default)

GET/api/v2/parse

List parse jobs for the current project.

Filter by status or creation date range. Results are paginated — use page_token from the response to fetch subsequent pages.

ParametersExpand Collapse

ParsingListParams parameters

DateTimeOffset? createdAtOnOrAfter

Include items created at or after this timestamp (inclusive)

formatdate-time

DateTimeOffset? createdAtOnOrBefore

Include items created at or before this timestamp (inclusive)

formatdate-time

IReadOnlyList<string>? jobIds

Filter by specific job IDs

string? organizationID

Long? pageSize

Number of items per page

string? pageToken

Token for pagination

string? projectID

Status? status

Filter by job status (PENDING, RUNNING, COMPLETED, FAILED, CANCELLED)

"CANCELLED"Cancelled

"COMPLETED"Completed

"FAILED"Failed

"PENDING"Pending

"RUNNING"Running

ReturnsExpand Collapse

class ParsingListPageResponse:

Response schema for paginated parse job queries.

required IReadOnlyList<ParsingListResponse> Items

The list of items.

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

IReadOnlyDictionary<string, string>? UserMetadata

Key/value tags associated with this job.

string? NextPageToken

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Long? TotalSize

The total number of items available. This is only populated when specifically requested. The value may be an estimate and can be used for display purposes only.

List Parse Jobs

C#

HTTP

TypeScript

Python

Go

Java

C#

CLI Tool

ParsingListParams parameters = new();

var page = await client.Parsing.List(parameters);
await foreach (var item in page.Paginate())
{
    Console.WriteLine(item);
}

200 example

{
  "items": [
    {
      "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",
      "user_metadata": {
        "owner": "jerry",
        "team": "research"
      }
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}

Returns Examples

200 example

{
  "items": [
    {
      "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",
      "user_metadata": {
        "owner": "jerry",
        "team": "research"
      }
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}