List Batches

client.batches.list(?, ?): ArrayPage<BatchJob { id, agent_id, background, 15 more } >

get/v1/messages/batches

List all batch runs.

ParametersExpand Collapse

query: BatchListParams { after, before, limit, 2 more }

after?: string | null

Job ID cursor for pagination. Returns jobs that come after this job ID in the specified sort order

before?: string | null

Job ID cursor for pagination. Returns jobs that come before this job ID in the specified sort order

limit?: number | null

Maximum number of jobs to return

order?: "asc" | "desc"

Sort order for jobs by creation time. 'asc' for oldest first, 'desc' for newest first

Accepts one of the following:

"asc"

"desc"

order_by?: "created_at"

Field to sort by

Accepts one of the following:

"created_at"

ReturnsExpand 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

List Batches

import Letta from '@letta-ai/letta-client';

const client = new Letta({
  apiKey: 'My API Key',
});

// Automatically fetches more pages as needed.
for await (const batchJob of client.batches.list()) {
  console.log(batchJob.id);
}

[
  {
    "id": "job-123e4567-e89b-12d3-a456-426614174000",
    "agent_id": "agent_id",
    "background": true,
    "callback_error": "callback_error",
    "callback_sent_at": "2019-12-27T18:11:19.117Z",
    "callback_status_code": 0,
    "callback_url": "callback_url",
    "completed_at": "2019-12-27T18:11:19.117Z",
    "created_at": "2019-12-27T18:11:19.117Z",
    "created_by_id": "created_by_id",
    "job_type": "job",
    "last_updated_by_id": "last_updated_by_id",
    "metadata": {
      "foo": "bar"
    },
    "status": "created",
    "stop_reason": "end_turn",
    "total_duration_ns": 0,
    "ttft_ns": 0,
    "updated_at": "2019-12-27T18:11:19.117Z"
  }
]

Returns Examples

[
  {
    "id": "job-123e4567-e89b-12d3-a456-426614174000",
    "agent_id": "agent_id",
    "background": true,
    "callback_error": "callback_error",
    "callback_sent_at": "2019-12-27T18:11:19.117Z",
    "callback_status_code": 0,
    "callback_url": "callback_url",
    "completed_at": "2019-12-27T18:11:19.117Z",
    "created_at": "2019-12-27T18:11:19.117Z",
    "created_by_id": "created_by_id",
    "job_type": "job",
    "last_updated_by_id": "last_updated_by_id",
    "metadata": {
      "foo": "bar"
    },
    "status": "created",
    "stop_reason": "end_turn",
    "total_duration_ns": 0,
    "ttft_ns": 0,
    "updated_at": "2019-12-27T18:11:19.117Z"
  }
]