Skip to main content
GET
List tasks in a batch

Authorizations

X-API-Key
string
header
required

API key for authentication. Get yours at platform.valyu.ai.

Path Parameters

id
string
required

Batch ID.

Query Parameters

status
enum<string>

Filter tasks by status.

Available options:
queued,
running,
completed,
failed,
cancelled
limit
integer

Maximum number of tasks to return.

Required range: x >= 1
last_key
string | null

Pagination cursor. Omit on first request. Pass the last_key value from a previous response to fetch the next page.

include_output
boolean
default:false

Include full output, sources, images, and cost for each task. When false (default), returns lightweight task listing with status only.

Response

Paginated list of batch tasks.

batch_id
string
required

ID of the batch these tasks belong to.

Example:

"batch_a1b2c3d4-e5f6-7890-abcd-ef1234567890"

tasks
object[]
required

Array of tasks in the batch.

pagination
object
required

Pagination metadata.