API Reference

View as Markdown

View as Markdown

Copy Markdown

---

Open in Claude

Open in ChatGPT

Batches

Create Batch

client.batches.create(BatchCreateParams { requests, callback_url } body, RequestOptionsoptions?): BatchJob { id, agent_id, background, 15 more }

post/v1/messages/batches

List Batches

client.batches.list(BatchListParams { after, before, limit, 2 more } query?, RequestOptionsoptions?): ArrayPage<BatchJob { id, agent_id, background, 15 more } >

get/v1/messages/batches

Retrieve Batch

client.batches.retrieve(stringbatchID, RequestOptionsoptions?): BatchJob { id, agent_id, background, 15 more }

get/v1/messages/batches/{batch_id}

Cancel Batch

client.batches.cancel(stringbatchID, RequestOptionsoptions?): BatchCancelResponse

patch/v1/messages/batches/{batch_id}/cancel

ModelsExpand Collapse

BatchJob { id, agent_id, background, 15 more }

id: string

The human-friendly ID of the Job

agent_id?: string | null

The agent associated with this job/run.

background?: boolean | null

Whether the job was created in background mode.

callback_error?: string | null

Optional error message from attempting to POST the callback endpoint.

callback_sent_at?: string | null

Timestamp when the callback was last attempted.

formatdate-time

callback_status_code?: number | null

HTTP status code returned by the callback endpoint.

callback_url?: string | null

If set, POST to this URL when the job completes.

completed_at?: string | null

The unix timestamp of when the job was completed.

formatdate-time

created_at?: string

The unix timestamp of when the job was created.

formatdate-time

created_by_id?: string | null

The id of the user that made this object.

job_type?: JobType

Accepts one of the following:

"job"

"run"

"batch"

last_updated_by_id?: string | null

The id of the user that made this object.

metadata?: Record<string, unknown> | null

The metadata of the job.

status?: JobStatus

The status of the job.

Accepts one of the following:

"created"

"running"

"completed"

"failed"

"pending"

"cancelled"

"expired"

stop_reason?: StopReasonType | null

The reason why the job was stopped.

Accepts one of the following:

"end_turn"

"error"

"llm_api_error"

"invalid_llm_response"

"invalid_tool_call"

"max_steps"

"no_tool_call"

"tool_rule"

"cancelled"

"requires_approval"

total_duration_ns?: number | null

Total run duration in nanoseconds

ttft_ns?: number | null

Time to first token for a run in nanoseconds

updated_at?: string | null

The timestamp when the object was last updated.

formatdate-time

BatchesMessages

List Messages For Batch

client.batches.messages.list(stringbatchID, MessageListParams { after, agent_id, before, 3 more } query?, RequestOptionsoptions?): ObjectPage<Message { id, role, agent_id, 21 more } >

get/v1/messages/batches/{batch_id}/messages