API Reference

Beta

Batch

Job Items

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List Batch Job Items

JobItemListPageResponse Beta.Batch.JobItems.List(JobItemListParamsparameters, CancellationTokencancellationToken = default)

GET/api/v1/beta/batch-processing/{job_id}/items

List items in a batch job with optional status filtering.

Useful for finding failed items, viewing completed items, or debugging processing issues.

ParametersExpand Collapse

JobItemListParams parameters

required string jobID

Long limit

Maximum number of items to return

maximum1000

minimum1

Long offset

Number of items to skip

minimum0

string? organizationID

string? projectID

Status? status

Filter items by status

"cancelled"Cancelled

"completed"Completed

"failed"Failed

"pending"Pending

"processing"Processing

"skipped"Skipped

ReturnsExpand Collapse

class JobItemListPageResponse:

Paginated response containing batch job item details.

IReadOnlyList<JobItemListResponse> Items

List of item details

required string ItemID

ID of the item

required string ItemName

Name of the item

required Status Status

Processing status of this item

One of the following:

"cancelled"Cancelled

"completed"Completed

"failed"Failed

"pending"Pending

"processing"Processing

"skipped"Skipped

DateTimeOffset? CompletedAt

When processing completed for this item

formatdate-time

DateTimeOffset EffectiveAt

string? ErrorMessage

Error message for the latest job attempt, if any.

string? JobID

Job ID for the underlying processing job (links to parse/extract job results)

string? JobRecordID

The job record ID associated with this status, if any.

string? SkipReason

Reason item was skipped (e.g., ‘already_processed’, ‘size_limit_exceeded’)

DateTimeOffset? StartedAt

When processing started for this item

formatdate-time

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 Batch Job Items

C#

HTTP

TypeScript

Python

Go

Java

C#

CLI Tool

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

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

200 example

{
  "items": [
    {
      "item_id": "item_id",
      "item_name": "item_name",
      "status": "cancelled",
      "completed_at": "2019-12-27T18:11:19.117Z",
      "effective_at": "2019-12-27T18:11:19.117Z",
      "error_message": "error_message",
      "job_id": "job_id",
      "job_record_id": "job_record_id",
      "skip_reason": "skip_reason",
      "started_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}

Returns Examples

200 example

{
  "items": [
    {
      "item_id": "item_id",
      "item_name": "item_name",
      "status": "cancelled",
      "completed_at": "2019-12-27T18:11:19.117Z",
      "effective_at": "2019-12-27T18:11:19.117Z",
      "error_message": "error_message",
      "job_id": "job_id",
      "job_record_id": "job_record_id",
      "skip_reason": "skip_reason",
      "started_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}