API Reference

Search

This endpoint is designed to return LLM-ready web results based on a user’s query. Based on a classification mechanism, it can return web results and news associated with your query. If you need to feed an LLM with the results of a query that sounds like What are the latest geopolitical updates from India, then this endpoint is the right one for you.

Authentication

X-API-Keystring

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

Query parameters

querystringRequired

The search query used to retrieve relevant results from the web. You can also include search operators to refine your search.

countintegerOptional1-100Defaults to 10

Specifies the maximum number of search results to return per section (the sections are web and news. See the JSON response to visualize them).

freshnessstringOptional
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 (i.e., less restrictive) of the two timeframes. For example, if you use `query=news+this+week&freshness=month`, the results will use a freshness of month.
offsetintegerOptional

Indicates the offset for pagination. The offset is calculated in multiples of count. For example, if count = 5 and offset = 1, results 5–10 will be returned. Range 0 ≤ offset ≤ 9.

countryenumOptional
The country code that determines the geographical focus of the web results.
languageenumOptionalDefaults to EN

The language of the web results that will be returned (BCP 47 format).

safesearchenumOptional
Configures the safesearch filter for content moderation. This allows you to decide whether to return NSFW content or not.
Allowed values:
livecrawlenumOptional

Indicates which section(s) of search results to livecrawl and return full page content.

Allowed values:
livecrawl_formatsenumOptional
Indicates the format of the livecrawled content.
Allowed values:

Response

A JSON object containing unified search results from web and news sources
resultsobject or null
metadataobject or null

Errors