API ReferenceAgents

Custom Agent

Beta
<Warning>Access to this endpoint requires a paid subscription plan</Warning> ## Description This endpoint lets you run an assistant you can configure in the UI. Users can create a custom AI agent by providing a description of the desired functionality using natural language. The system supports both conversational inputs and advanced prompting techniques to define the agent’s behavior. Before using it, [create a custom agent and retrieve its ID](/agents/custom/create-agents). ## Enterprise Settings To maintain enterprise security, enable Zero Data Retention on your enterprise account. Manage this setting at [you.com/settings/privacy](https://you.com/settings/privacy). When enabled, the platform does not retain your data and does not use customer data for model training. <Warning>Privacy settings can only be managed by You.com Enterprise or team admins.</Warning> <Info>The call only returns when the agent has finished fully responding to the input question.</Info>

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.
agentstringRequired

Set the value to a Custom Agent’s ID. Learn how to obtain an agent ID here Create Custom Agents.

inputstringRequired
The question you'd like to ask the agent
streamfalseRequired

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.

Response

agentstring
The id of the agent populated in the request.
inputobject
The users access role and question you asked the agent
outputobject
The response populated by the agent.

Errors