Skip to main content
POST
Execute Batched Grid Workflow

Headers

x-api-key
string
required

Body

application/json
name
string | null

The name of the batched grid workflow.

description
string | null

The description of the batched grid workflow.

agent_completions
AgentSpec · object[] | null

The agent completions to be completed by the batched grid workflow.

Maximum array length: 50
tasks
string[] | null

The tasks to be completed by the batched grid workflow.

Maximum array length: 50
max_loops
integer | null
default:1

The maximum number of loops to be completed by the batched grid workflow. At most 50.

Required range: 1 <= x <= 50
imgs
string[] | null

Not supported. The grid runs every agent without images, so a non-empty list is rejected with 422.

Response

Successful Response

job_id
string
required

The job ID of the batched grid workflow.

status
string
required

"success" when every agent ran, "partial" when at least one failed. A run where every agent fails returns 502 and is not charged.

outputs
any
required

One entry per loop, mapping each agent name to its output, or to {"error": ": "} if that agent failed.

usage
Usage · object
required

The usage of the batched grid workflow.

timestamp
string
required

The timestamp of the batched grid workflow.

name
string | null

The name of the batched grid workflow.

description
string | null

The description of the batched grid workflow.