Advanced Agent

Beta

This endpoint answers the user’s query with an LLM. Optionally, you can ground the answer using web results (max 1 web search).

Use it for answering simple questions that require a low latency response.

The data returns as SSE (Server-Side Events) with the text/event-stream content type in the response header. It streams data in while the agent is responding.

Authentication

AuthorizationBearer

A unique API Key is required to authorize API access. For details, see how to get your API Key.

Request

This endpoint expects an object.
agentenumRequired
Setting this value to "advanced" is mandatory to use the advanced agent.
Allowed values:
inputstringRequired
The question you'd like to ask the agent
streamtrueRequired

Must be set to true when you want to stream the agent response as its being generated, and false when you want the response to return after the agent has finished.

toolslist of objectsOptional
The advanced agent accepts either `compute` or `research` tools <Note> Compute allows your agent to use a Python code interpreter for tasks such as data analysis, mathematical calculations, and plot generation.<br><br> Research iteratively searches the web, analyzes the results, and stops when finished. It then provides a comprehensive report to your agent with current, cited information.</Note>
verbosityenumOptional

Controls the level of detail provided by the agent’s response. Choosing high maps to a long-form report while medium maps to a medium verbosity report that captures most details but is less comprehensive.

Allowed values:
workflow_configobjectOptional

Defines the maximum number of steps the agent uses in its workflow plan to answer your query. Higher values allow for more tool calls, but it takes longer for the agent to provide the response. For instance, setting max_workflow_steps=5 could allow the agent to call the research tool 3 times and the compute tool 2 times.

Response

This endpoint answers the user’s query with an LLM. Optionally, you can ground the answer using web results (max 1 web search).

Use it for answering simple questions that require a low latency response.

The data returns as SSE (Server-Side Events) with the text/event-stream content type in the response header. It streams data in while the agent is responding.

response.createdobject
SSE event signifying the response stream has been created
OR
response.startingobject
SSE event signifying the response is starting
OR
response.output_item.addedobject
SSE event signifying an output item has been added
OR
response.output_content.fullobject
OR
response.output_item.doneobject
OR
response.output_text.deltaobject
OR
response.doneobject

Errors