v2

latestOpenAPI 3.0.12026-07-26152429.0 KB

AI search

Search the web and return an extracted answer guided by a natural-language prompt. Requires a valid API key for an account with an active AI subscription plan; AI usage is billed separately from credits.

post/ai/search

Request body

searchstring
search_limitinteger
fetch_page_contentboolean
locationstring
countrystring
languagestring
latitudenumber double

Latitude for exact-coordinate localization (Google engine only). Must be paired with longitude. Takes precedence over location when both are set.

longitudenumber double

Longitude for exact-coordinate localization (Google engine only). Must be paired with latitude.

radiusinteger

Optional bias radius in meters for coordinate localization. Defaults to -1 (unset).

numinteger
pageinteger
promptstring required
extraction_schemaobject
cleaning_intent'extraction' | 'action' | 'general'

Response

Successful AI search