Skip to main content
POST
web.search-context

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

Search query to gather relevant page excerpts.

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})?$
maxTokens
integer
default:8192

Approximate total token budget, 1024 to 32768. Default 8192.

Required range: 1024 <= x <= 32768
maxUrls
integer
default:20

Maximum distinct page URLs, 1 to 50. Default 20.

Required range: 1 <= x <= 50
count
integer
default:20

Search results considered, 1 to 50. Default 20.

Required range: 1 <= x <= 50
snippets
integer
default:50

Maximum text chunks, 1 to 256. Default 50.

Required range: 1 <= x <= 256
perUrlTokens
integer
default:4096

Approximate tokens per URL, 512 to 8192. Default 4096.

Required range: 512 <= x <= 8192

Adult content filtering.

Available options:
off,
moderate,
strict
goggles
string[]

Optional custom search ranking rules, at most three.

Maximum array length: 3

Public URL or definition of search ranking rules.

Required string length: 1 - 16000

Response

The result

items
object[]
required

Pages with extracted text.

truncated
boolean
required

True when local output limits shortened the excerpts.