Custom Agent | You.com | Documentation

curl -X POST https://api.you.com/v1/agents/runs \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "agent": "63773261-b4de-4d8f-9dfd-cff206a5cb51",
  "input": "What is the capital of France?",
  "stream": false
}'

{
  "agent": "63773261-b4de-4d8f-9dfd-cff206a5cb51",
  "input": [
    {
      "role": "user",
      "content": "What is the capital of France?"
    }
  ],
  "output": [
    {
      "type": "web_search.results",
      "content": [
        {
          "source_type": "web_search",
          "citation_uri": "https://en.wikipedia.org/wiki/Paris",
          "title": "Paris - Wikipedia",
          "snippet": "Paris is the capital and largest city of France, with an estimated city center population of 2,048,472, and a metropolitan population of 13,171,056 as of ...",
          "url": "https://en.wikipedia.org/wiki/Paris",
          "provider": null,
          "thumbnail_url": "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcSuabbjyTSQdm08in1kajd3LW1841TxBxaHjERnGccFRjyxmT-SCDF4Ces&s"
        }
      ]
    },
    {
      "type": "message.answer",
      "text": "#### Capital of France\n\nThe capital of France is **Paris**. It is not only the capital but also the most populous city in the country. Paris is situated on the Seine River in the northern part of France, within the Île-de-France region. It serves as the main cultural, economic, and political center of France [[1]](https://www.coe.int/en/web/interculturalcities/paris)[[2]](https://en.wikipedia.org/wiki/Paris)."
    }
  ]
}

Description

This endpoint lets you run an assistant you can configure within our web product at https://you.com/agents. The system supports both conversational inputs and advanced prompting techniques to define the agent’s behavior.

The call only returns when the agent has finished fully responding to the input question.

Enterprise Settings

To maintain enterprise security, enable Zero Data Retention on your enterprise account. Manage this setting at you.com/settings/privacy. When enabled, we do not retain your data and do not use it for model training.

Privacy settings can only be managed by You.com Enterprise or team admins.

## Description This endpoint lets you run an assistant you can configure within our web product at https://you.com/agents. The system supports both conversational inputs and advanced prompting techniques to define the agent’s behavior. <Info>The call only returns when the agent has finished fully responding to the input question.</Info> ## 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, we do not retain your data and do not use it for model training. <Warning>Privacy settings can only be managed by You.com Enterprise or team admins.</Warning>

Authentication

AuthorizationBearer

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

Request

The parameters we pass to ask the agent a question

agentstringRequired

Your Custom Agent’s ID. To obtain one you must have created a custom agent at https://you.com/agents.

Your Custom Agent's ID. To obtain one you must have created a custom agent at https://you.com/agents.

inputstringRequired

The question you'd like to ask the agent

streamfalseRequired

Must be true to stream the agent response as it’s generated, and false to receive a response after the agent has finished.

Response

agentstring

The id of the agent populated in the request.

inputlist of objects

The users access role and question you asked the agent

outputlist of objects

The agent's response items

Errors

400

Bad Request Error

422

Unprocessable Entity Error