Returns comprehensive research-grade answers with multi-step reasoning
Changed onResearch goes beyond a single web search. In response to your question, it runs multiple searches, reads through the sources, and synthesizes everything into a thorough, well-cited answer. Use it when a question is too complex for a simple lookup, and when you need a response you can actually trust and verify.
Request
- Base URLhttps://api.you.com
- AuthAPI key in header X-API-Key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Request body
Example request
{
"input": "Which global cities improved air quality the most over the past 10 years, and what measurable actions contributed?",
"research_effort": "lite",
"source_control": {
"include_domains": [
"nytimes.com",
"bbc.com"
],
"exclude_domains": [
"spam-site.com",
"other-site.com"
],
"boost_domains": [
"nytimes.com",
"wired.com"
]
},
"output_schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"gtin": {
"type": [
"string",
"null"
]
}
},
"required": [
"name",
"gtin"
],
"additionalProperties": false
}
}Response
In synchronous mode (background: false, the default), a JSON object containing a comprehensive answer with citations and supporting search results. In background mode (background: true), a JSON object with a task handle that you can poll or stream for the final result.
Example response
{
"output": {
"content_type": "text",
"sources": [
{
"url": "https://sustainablemobility.iclei.org/air-pollution-beijing/",
"title": "Clearing the skies: how Beijing tackled air pollution & what lies ahead",
"snippets": [
"The city actively coordinated air pollution control measures with surrounding areas, such as the Beijing-Tianjin-Hebei region."
]
}
]
},
"warnings": []
}Changes
- breaking
request property
/was restricted to a list of enum values - breaking
the
/request property type changed fromstringto no type - breaking
added to the response body
oneOflist for the response status - info
added the new
ARenum value to the request property/ - info
added the new
ATenum value to the request property/ - info
added the new
AUenum value to the request property/ - info
added the new
BEenum value to the request property/ - info
added the new
BRenum value to the request property/ - info
added the new
CAenum value to the request property/ - info
added the new
CHenum value to the request property/ - info
added the new
CLenum value to the request property/ - info
added the new
CNenum value to the request property/ - info
added the new
DEenum value to the request property/ - info
added the new
DKenum value to the request property/ - info
added the new
ESenum value to the request property/ - info
added the new
FIenum value to the request property/ - info
added the new
FRenum value to the request property/ - info
added the new
GBenum value to the request property/ - info
added the new
HKenum value to the request property/ - info
added the new
IDenum value to the request property/ - info
added the new
INenum value to the request property/ - info
added the new
ITenum value to the request property/ - info
added the new
JPenum value to the request property/ - info
added the new
KRenum value to the request property/ - info
added the new
MXenum value to the request property/ - info
added the new
MYenum value to the request property/ - info
added the new
NLenum value to the request property/ - info
added the new
NOenum value to the request property/ - info
added the new
NZenum value to the request property/ - info
added the new
PHenum value to the request property/ - info
added the new
PLenum value to the request property/ - info
added the new
PTenum value to the request property/ - info
added the new
RUenum value to the request property/ - info
added the new
SAenum value to the request property/ - info
added the new
SEenum value to the request property/ - info
added the new
TRenum value to the request property/ - info
added the new
TWenum value to the request property/ - info
added the new
USenum value to the request property/ - info
added the new
ZAenum value to the request property/ - info
added the new
frontierenum value to the request property - info
added
subschema #2to the/request propertyoneOflist - info
removed from the response body
oneOflist for the response status
- breaking
- breaking
added to the response body
oneOflist for the response status - breaking
the response's body type changed from
objectto no type for status - breaking
removed the required property
from the response with the status - info
added the new optional request property
- info
added the new optional request property
- info
added the new optional request property
- breaking