Skip to main content
POST
Search the web
From 1 credit per 10 results See the guide for examples and usage.

Authorizations

Authorization
string
header
required

Send Authorization: Bearer <API_KEY>. Keys have full access unless restricted to scopes.

Body

application/json
query
string
required

Search query. Accepts natural language as well as Google-style search operators such as site:, -site:, inurl:, intitle:, quoted phrases, and OR.

Required string length: 1 - 500
numResults
integer
default:10

Number of results to request and return (10–100). Defaults to 10.

Required range: 10 <= x <= 100
includeDomains
string[]

Allowlist — only return results from these domains. Up to 100 domains. Example: ["arxiv.org", "github.com"].

Maximum array length: 100
excludeDomains
string[]

Blocklist — drop results from these domains. Up to 100 domains. Example: ["pinterest.com", "reddit.com"].

Maximum array length: 100
freshness
enum<string>

Restrict results to content published within this window.

Available options:
last_24_hours,
last_week,
last_month,
last_year
country
enum<string>

Two-letter ISO 3166-1 alpha-2 country code to localize results to a specific country (maps to Google's gl parameter). Example: "us", "gb", "de".

Available options:
af,
al,
dz,
as,
ad,
ao,
ai,
aq,
ag,
ar,
am,
aw,
au,
at,
az,
bs,
bh,
bd,
bb,
by,
be,
bz,
bj,
bm,
bt,
bo,
ba,
bw,
bv,
br,
io,
bn,
bg,
bf,
bi,
kh,
cm,
ca,
cv,
ky,
cf,
td,
cl,
cn,
cx,
cc,
co,
km,
cg,
cd,
ck,
cr,
ci,
hr,
cu,
cy,
cz,
dk,
dj,
dm,
do,
ec,
eg,
sv,
gq,
er,
ee,
et,
fk,
fo,
fj,
fi,
fr,
gf,
pf,
tf,
ga,
gm,
ge,
de,
gh,
gi,
gr,
gl,
gd,
gp,
gu,
gt,
gn,
gw,
gy,
ht,
hm,
va,
hn,
hk,
hu,
is,
in,
id,
ir,
iq,
ie,
il,
it,
jm,
jp,
jo,
kz,
ke,
ki,
kp,
kr,
kw,
kg,
la,
lv,
lb,
ls,
lr,
ly,
li,
lt,
lu,
mo,
mk,
mg,
mw,
my,
mv,
ml,
mt,
mh,
mq,
mr,
mu,
yt,
mx,
fm,
md,
mc,
mn,
ms,
ma,
mz,
mm,
na,
nr,
np,
nl,
an,
nc,
nz,
ni,
ne,
ng,
nu,
nf,
mp,
no,
om,
pk,
pw,
ps,
pa,
pg,
py,
pe,
ph,
pn,
pl,
pt,
pr,
qa,
re,
ro,
ru,
rw,
sh,
kn,
lc,
pm,
vc,
ws,
sm,
st,
sa,
sn,
rs,
sc,
sl,
sg,
sk,
si,
sb,
so,
za,
gs,
es,
lk,
sd,
sr,
sj,
sz,
se,
ch,
sy,
tw,
tj,
tz,
th,
tl,
tg,
tk,
to,
tt,
tn,
tr,
tm,
tc,
tv,
ug,
ua,
ae,
gb,
us,
um,
uy,
uz,
vu,
ve,
vn,
vg,
vi,
wf,
eh,
ye,
zm,
zw
queryFanout
boolean

Currently has no effect.

markdownOptions
object

Inline Markdown scraping for each result. Set enabled: true to activate.

highlightsOptions
object

Passages from each result page that are relevant to the query. Pages are read with the markdownOptions settings.

timeoutOpts
object

Request deadline and what to return when it passes.

zdr
enum<string>
default:disabled

enabled turns on zero data retention. Returns 403 ZDR_NOT_ENABLED unless your organization has ZDR.

Available options:
enabled,
disabled
tags
string[]

Labels for filtering usage in the dashboard.

Maximum array length: 20
Required string length: 1 - 50
Example:

Response

Search succeeded. Results are ordered by relevance.

results
object[]
required
query
string
required

Echo of the original query (useful when fanout was enabled).

request_id
string<uuid>
required

Unique ID of this request, also in X-Request-Id. Include it when contacting support.

Example:

"3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91"

cache_metadata
object
required

Whether this response came from cache.

partial
boolean

True when timeoutOpts.behavior=return-partial returned the usable results collected before the deadline. Partial collections are not cached as complete results.

key_metadata
object

Credits this request used and your remaining balance.