Skip to main content
POST
Web Search

Authorizations

Authorization
string
header
required

API key from Settings > Developer > REST API

Headers

Moda-Version
enum<string>
default:2026-05-01

Calendar-dated API version pin. New integrations should pin 2026-05-01 to opt into the newest response shapes. For back-compat the server also accepts requests with no header and resolves them to the current default (today: 2026-04-12); that default advances on each sunset date. Any unsupported value returns 400 unsupported_version.

Available options:
2026-04-12,
2026-05-01
Example:

"2026-05-01"

Body

application/json
query
string
required

The search query.

Required string length: 1 - 2000
num_results
integer
default:5

Results to return (max 10).

Required range: 1 <= x <= 10
include_text
boolean
default:false

Also return each result's leading document text (~2000 chars) as text.

idempotency_key
string | null

A retried call with the same key replays the stored response (replayed:true) instead of paying for a second provider request.

Maximum string length: 200

Response

Successful Response

The response is of type Response Websearch · object.