For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Returns a synthesized natural-language answer with citations and the web results used to generate it. Provide a query and optional freshness, locale, domain, and explicit-content controls.
Authentication
X-API-Keystring
The unique API Key required to authorize API access. Learn how to get yours in the ["Get your API key" section of the documentation](https://you.com/docs/quickstart#get-your-api-key).
Request
This endpoint expects an object.
querystringRequiredformat: "\S"<=400 characters
The search query used to retrieve relevant web results.
freshnessenum or stringOptional
Specifies the freshness of the results to return. Provide either one of `day`, `week`, `month`, `year`, or a date range string in the format `YYYY-MM-DDtoYYYY-MM-DD`.
When your search query includes a temporal keyword and you also set a freshness parameter, the search will use the broader timeframe. For example, if you use `query=news+this+week&freshness=month`, the results will use a freshness of month.
countryenumOptional
A supported country code that determines the geographical focus of the web results.
languageenumOptional
A supported BCP 47 language tag that determines the language of the web results.
safesearchenumOptionalDefaults to moderate
Configures the safesearch filter for content moderation. This allows you to decide whether to return NSFW content or not.
Allowed values:
include_domainslist of stringsOptional
Domains to exclusively include in web results. This is a strict allowlist, not a ranking boost. Supports up to 500 domains. Cannot be combined with exclude_domains or boost_domains.
exclude_domainslist of stringsOptional
Domains to exclude from web results. Supports up to 500 domains. Cannot be combined with include_domains. Can be combined with boost_domains.
boost_domainslist of stringsOptional
Domains to prefer in search ranking without excluding results from other domains. Supports up to 500 domains. Can be combined with exclude_domains, but not with include_domains.
Response
A JSON object containing a synthesized answer with citations and supporting search results
answerstring
The synthesized response with numbered inline citations that reference items in the citations array.
citationslist of objects
The sources cited in the answer, in citation order. Each item includes the source URL and verbatim excerpts that support the answer.
resultsobject
Search results grouped by result type. All current search results are grouped under web.
Specifies the freshness of the results to return. Provide either one of day, week, month, year, or a date range string in the format YYYY-MM-DDtoYYYY-MM-DD.
When your search query includes a temporal keyword and you also set a freshness parameter, the search will use the broader timeframe. For example, if you use query=news+this+week&freshness=month, the results will use a freshness of month.