Sign in
latestOpenAPI 3.1.02026-08-23255084.8 KB

e7d4c56c12c7

Reasoning Agents

Execute Reasoning Agent Completion

Execute a reasoning agent with advanced cognitive capabilities for complex problem-solving tasks. This is a premium-only feature.

post/v1/reasoning-agent/completions

Headers

x-api-keystring required

Request body

agent_namestring nullable

The unique name assigned to the reasoning agent.

descriptionstring nullable

A detailed explanation of the reasoning agent's purpose and capabilities.

model_namestring nullable

The name of the AI model that the reasoning agent will utilize.

system_promptstring nullable

The initial instruction or context provided to the reasoning agent.

max_loopsinteger nullable

The maximum number of times the reasoning agent is allowed to repeat its task. At most 50.

swarm_type'reasoning-duo' | 'self-consistency' | 'ire' | 'reasoning-agent' | 'consistency-agent' | 'ire-agent' | 'ReflexionAgent' | 'GKPAgent' | 'AgentJudge' nullable

The type of reasoning swarm to use (e.g., reasoning duo, self-consistency, IRE).

num_samplesinteger nullable

The number of samples to generate for the reasoning agent.

output_type'list' | 'dict' | 'dictionary' | 'string' | 'str' | 'final' | 'last' | 'json' | 'all' | 'yaml' | 'xml' | 'dict-all-except-first' | 'str-all-except-first' | 'basemodel' | 'dict-final' | 'list-final' nullable

The type of output format for the reasoning agent.

num_knowledge_itemsinteger nullable

The number of knowledge items to use for the reasoning agent.

memory_capacityinteger nullable

The memory capacity for the reasoning agent.

taskstring nullable

The task to be completed by the reasoning agent.

Response

Successful Response

job_idstring required

Unique identifier for the reasoning agent run.

statusstring

Status of the reasoning agent run.

{"stackTrail":"components:schemas:ReasoningAgentCompletionOutput:properties:outputs","oasType":"schema","type":"unknown","title":"Outputs","description":"The output generated by the reasoning agent. Shape varies by reasoning type."}
timestampstring required

ISO-formatted timestamp of when the run was executed.

agent_namestring required

Name of the agent.

agent_typestring required

Type of the agent (swarm type).

agent_idstring required

Unique identifier for the agent instance.

usageobject required

Token usage statistics including input, output, and total tokens.