Skip to main content
POST
Search

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body model for the /search endpoint

query
string
required

Search query string

Minimum string length: 1
locale
string
default:en

Language/locale code (e.g., 'en', 'fr', 'de')

Example:

"en-US"

country
string
default:US

Country code for geo-targeted results (e.g., 'US', 'GB', 'IL')

Example:

"US"

output_format
enum<string>
default:markdown

Output format: plain_text, markdown, or simplified_html

Available options:
plain_text,
markdown,
simplified_html
max_results
integer
default:3

Maximum number of results to return. Actual count may be lower depending on availability

Required range: 1 <= x <= 100
focus

Search focus mode (e.g., 'general', 'news', 'shopping')

Available options:
general,
news,
location,
coding,
geo,
shopping,
social,
academic
content_type
string[] | null

Filter by content type (only supported with focus=general). Supports semantic groups ('documents', 'spreadsheets', 'presentations') and specific formats ('pdf', 'docx', 'xlsx', etc.)

Maximum array length: 50
search_depth
enum<string>
default:lite

Controls content richness and latency. lite = metadata only (title, snippet, URL), fast = rich content (~2K chars), deep = full page scraping

Available options:
lite,
fast,
deep
exclude_domains
string[] | null

List of domains to exclude from search results. Maximum 50 domains

Maximum array length: 50
include_domains
string[] | null

List of domains to include in search results. Maximum 50 domains

Maximum array length: 50
start_date
string | null

Filter results after this date (format: YYYY-MM-DD or YYYY)

end_date
string | null

Filter results before this date (format: YYYY-MM-DD or YYYY)

time_range
enum<string>

Filter by recency: hour, day, week, month, or year. Cannot be combined with start_date/end_date

Available options:
hour,
day,
week,
month,
year
max_subagents
integer
default:3

Maximum number of subagents to execute in parallel for WSA focus modes (shopping, social, geo). Ignored for SERP focus modes

Required range: 1 <= x <= 10

Response

Successful Response

Search API response containing search results with titles, descriptions, URLs, and content

total_results
integer
required

Total number of search results returned in this response

Example:

10

results
SearchResultModel · object[]
required

Array of search results, each containing title, description, URL, content (in Deep Search mode), and optional metadata

request_id
string
required

Unique identifier for tracking this search request

Example:

"123e4567-e89b-12d3-a456-426614174000"