Skip to main content
GET
/
v1
/
search
Returns a list of unified search results from web and news sources
curl --request GET \
  --url https://api.ydc-index.io/v1/search \
  --header 'X-API-Key: <api-key>'
{
"results": {
"web": [
{
"url": "https://you.com",
"title": "The World's Greatest Search Engine!",
"description": "Search on YDC",
"snippets": [
"I'm an AI assistant that helps you get more done. What can I help you with?"
],
"thumbnail_url": "https://www.somethumbnailsite.com/thumbnail.jpg",
"page_age": "2025-06-25T11:41:00",
"authors": [
"John Doe"
],
"favicon_url": "https://someurl.com/favicon"
}
],
"news": [
{
"title": "Exclusive | You.com becomes the backbone of the EU's AI strategy",
"description": "As the EU's AI strategy is being debated, You.com becomes the backbone of the EU's AI strategy.",
"page_age": "2025-06-25T11:41:00",
"thumbnail_url": "https://www.somethumbnailsite.com/thumbnail.jpg",
"url": "https://www.you.com/news/eu-ai-strategy-youcom"
}
]
},
"metadata": {
"request_uuid": "942ccbdd-7705-4d9c-9d37-4ef386658e90",
"query": "Your query",
"latency": 0.123
}
}
WARNING: If you would like to use Bearer token authentication to integrate with Databricks Unity Catalog, please use the /v2/search endpoint instead of /search
ATTENTION: The correct cURL code to use in your API call is in the playground. Click on Try it in the bar above to open the playground.

Description

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 is the weather like in France in September?, then this endpoint is the right one for you.

Search Operators

OperatorDescriptionExample
siteSearches for webpages from a particular domain (including subdomains)site:uscourts.gov USA v. Enron
filetypeSearches for webpages that are of the specified file typeUSA v. Enron filetype:pdf
langSearches for webpages that are in a particular language (ISO 639-1 format)Modelo lang:es
+Searches for webpages that contain the exact term after the +Enron +GAAP
-Searches for webpages that do not contain the exact term after the -guitar -prs
ANDLogical operator to combine expressionsguitar +prs AND +silversky
ORLogical operator to combine expressionsguitar -prs AND -silversky
NOTNegation of expressionsUSA v. Enron NOT site:uscourts.gov

Errors

The endpoint returns as a structured JSON object with status, code, title, and detail fields:
HTTPCodeWhen it happens
401bad_requestThis can happen for a missing API key: {"detail": "API key is required"}, an invalid/expired API key: {"detail": "Invalid or expired API key"} or for other auth parsing errors: {"detail": "<error message>"}
403forbiddenAPI key lacks scope for the path (e.g., /v1/search): {"detail": "Missing required scopes"}
500Internal Server Error (auth/authorization middleware)This can happen in the case of authentication failure: {"detail": "Internal authentication error"} or authorization failure: {"detail": "Internal authorization error"}

Authorizations

X-API-Key
string
header
required

The unique API Key required to authorize API access. Learn how to get yours in the “Get your API key” section of the documentation.

Query Parameters

query
string
default:Your query
required

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

count
integer

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

Required range: 1 <= x <= 100
freshness
enum<string>

Specifies the freshness of the results to return.

Available options:
day,
week,
month,
year
offset
integer

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.

country
enum<string>

The country code that determines the geographical focus of the web results.

Available options:
AR,
AU,
AT,
BE,
BR,
CA,
CL,
DK,
FI,
FR,
DE,
HK,
IN,
ID,
IT,
JP,
KR,
MY,
MX,
NL,
NZ,
NO,
CN,
PL,
PT,
PH,
RU,
SA,
ZA,
ES,
SE,
CH,
TW,
TR,
GB,
US
safesearch
enum<string>

Configures the safesearch filter for content moderation. This allows you to decide whether to return NSFW content or not.

Available options:
off,
moderate,
strict
livecrawl
enum<string>

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

Available options:
web,
news,
all
livecrawl_formats
enum<string>

Indicates the format of the livecrawled content.

Available options:
html,
markdown

Response

A JSON object containing unified search results from web and news sources

results
object
metadata
object
I