v19

latestOpenAPI 3.1.02026-08-08224880.8 KB

Agents

Batch Processing

Execute Batch Agent Completions

Execute multiple agent completions concurrently using optimized thread pool execution. This is a premium-only feature.

post/v1/agent/batch/completions

Headers

x-api-keystring required

Request body

taskstring nullable

The task to be completed by the agent.

imgstring nullable

A base64 encoded image for the agent to process. Encode your image file to base64 and pass it here.

imgsstring[] nullable

A list of base64 encoded images for the agent to process. Encode your image files to base64 and pass them here.

tools_enabledstring[] nullable

A list of tools that the agent should use to complete its task.

Response

Successful Response

batch_idstring nullable

The unique identifier for the agent batch completion.

total_requestsinteger nullable

The total number of requests in the batch.

{"stackTrail":"components:schemas:AgentBatchCompletionResponse:properties:results:anyOf","oasType":"schema","type":"unknown","title":"Results","description":"The outputs generated by the agent.","nullable":true}

execution_timenumber nullable

The execution time of the agent batch completion.

timestampstring nullable

The timestamp when the agent batch completion was created.