Skip to main content
POST
web.query-suggest

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
query
string
required

Partial search query, at most 400 characters and 50 words.

country
string

Two-letter country preference, e.g. US.

Required string length: 1 - 2
Pattern: ^[a-z]{2}$
language
string

Language preference, e.g. en.

Required string length: 1 - 16
Pattern: ^[a-z]{2,3}(?:-[a-z]{2,4})?$
limit
number

Maximum suggestions, 1 to 20. Default 5.

Required range: x >= 1
enrich
boolean
default:false

Include public entity descriptions when supported; may cost more.

Response

The result

results
object[]
required

The matching items.

nextCursor
string

Pass as cursor to get the next page; absent on the last page.