Express Agent | YDC | Documentation

1 import requests 2 3 url = "https://api.you.com/v1/agents/runs" 4 5 payload = { 6 "agent": "express", 7 "input": "What is the capital of France?", 8 "stream": False 9 } 10 headers = { 11 "Authorization": "Bearer <token>", 12 "Content-Type": "application/json" 13 } 14 15 response = requests.post(url, json=payload, headers=headers) 16 17 print(response.json())

1 { 2 "agent": "express", 3 "input": { 4 "role": "user", 5 "content": "What is the capital of France?" 6 }, 7 "output": { 8 "type": "message.answer", 9 "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).", 10 "content": [ 11 { 12 "source_type": "web_search", 13 "citation_uri": "https://en.wikipedia.org/wiki/Paris", 14 "title": "Paris - Wikipedia", 15 "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 ...", 16 "url": "https://en.wikipedia.org/wiki/Paris", 17 "provider": null, 18 "thumbnail_url": "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcSuabbjyTSQdm08in1kajd3LW1841TxBxaHjERnGccFRjyxmT-SCDF4Ces&s" 19 } 20 ] 21 } 22 }

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 a JSON payload with a application/json content type

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

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 a JSON payload with a `application/json` content type <Note>The call only returns when the agent has finished fully responding to the input question.</Note>

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

streamfalseRequired

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

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.

Authentication

Request

Response

Errors