Express 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. <Info> This call streams data as the agent responds.</Info>

Authentication

AuthorizationBearer

A unique API Key required to authorize API access. Ensure it is kept confidential. Get a free API Key at you.com/platform.

Request

This endpoint expects an object.
agentenumRequired
Setting this value to "express" is mandatory to use the express 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 express agent response as its being generated, and false when you want the response to return after the agent has finished.

toolslist of objectsOptional

You can optionally ground the express agent response using results fetched from the web (max 1 web search)

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. <Info> This call streams data as the agent responds.</Info>
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