v46

latestOpenAPI 3.1.0raw.githubusercontent.com2025-11-25213680.0 KB

Run Agent

Run an agent with the specified task. Supports streaming when stream=True.

post/v1/agent/completions

Headers

x-api-keystring required

Request body

taskstring nullable

The task to be completed by the agent.

imgstring nullable

An optional image URL that may be associated with the agent's task or representation.

imgsstring[] nullable

A list of image URLs that may be associated with the agent's task or representation.

tools_enabledstring[] nullable

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

Response

Successful Response

job_idstring nullable

The unique identifier for the agent completion.

successboolean nullable

Indicates whether the agent completion was successful.

namestring nullable

The name of the agent.

descriptionstring nullable

A description of the agent or completion.

temperaturenumber nullable

The temperature setting used for the agent's response generation.

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

usageobject nullable

Usage statistics or metadata for the agent completion.

timestampstring nullable

The timestamp when the agent completion was created.