POST
Search

Authorizations

Authorization
string
header
required

Every request carries a bearer API key, which looks like ph_live_.... Keep keys server-side, because a key grants full control of your sessions. A missing header returns 401; an invalid or revoked key currently returns 403, so treat the two together as authentication failure.

Body

application/json
query
string
required

The search query. Minimum length 1.

Minimum string length: 1
engine
string
default:bing

An engine from GET /v1/search/engines. Omit for the default.

count
integer
default:10

How many results to return. Defaults to 10, bounded by the engine maximum.

Required range: 1 <= x <= 100
offset
integer
default:0

Result offset for paging.

Required range: x >= 0
session_id
string | null

Drive an existing session instead of an internal one.

collapse_domains
boolean
default:false

Return at most one hit per domain.

Response

Successful Response

query
string
required
engine
string
required
count
integer
required
offset
integer
required
total_found
integer
required
has_more
boolean
required
results
SearchHitModel · object[]
status
string
default:ok
reason
string | null
knowledge_graph
Knowledge Graph · object | null
people_also_ask
any[]
answer_box
string | null