Search Intelligence API endpoints
Run a single query across Google plus the major AI search platforms (ChatGPT, Perplexity, Gemini, Claude, Grok, Bing) and get structured per-platform results in one call. Includes brand and domain…
Run a single query across Google plus the major AI search platforms (ChatGPT, Perplexity, Gemini, Claude, Grok, Bing) and get structured per-platform results in one call. Includes brand and domain extraction.
The Search Intelligence agent API lets you run a single search query in parallel across Google and the major AI platforms, then get back a structured response with per-platform results, citations, and (optionally) brand/domain extraction. Use it to power external dashboards, citation monitors, and AI-search visibility reports.
Endpoints at a glance
POST /api/agent/v1/search-intelligence/query
search_intelligence:query
Run a query across the requested platforms. Synchronous — returns once all platforms settle or the 90s budget expires.
GET /api/agent/v1/search-intelligence/query/:runId
search_intelligence:query
Fetch a previously-run query by runId. Useful when the original POST timed out at the wall-clock budget but partial state is in the DB.
Authentication and scope
Both endpoints use the standard agent API auth: Authorization: Bearer rk_live_.... Add the search_intelligence:query scope to your API key under Settings > API keys (the scope name in the picker is exactly search_intelligence:query).
Supported platforms
The platforms field accepts any subset of the following (max 7):
google_organic— Google organic SERP results (parsed)chatgpt— ChatGPT response with citationsperplexity— Perplexity answer with sourcesgemini— Google Gemini responseclaude— Anthropic Claude responsegrok— xAI Grok responsebing— Bing organic SERP results
If platforms is omitted, the default set is ["google_organic", "chatgpt", "perplexity", "gemini"].
Run a query
query
string
Yes
—
The search query. 1–250 characters.
platforms
array
No
see above
Up to 7 platform identifiers. Duplicates rejected.
location
string
No
"United States"
Display name of the search location (max 255 chars).
gl
string
No
"us"
Two-letter country code for SERP context.
language
string
No
"en"
Language code (e.g. en, es, de).
hl
string
No
"en"
UI language hint passed to providers that accept it.
device
enum
No
"desktop"
"desktop" or "mobile".
includeRaw
boolean
No
false
If true, the response includes the raw upstream payload per platform (larger payload).
extract.brands
array
No
—
Up to 20 brand names to detect mentions of in each platform's response.
extract.domains
array
No
—
Up to 20 domains to detect citations of in each platform's response.
Response (200 OK)
The response includes the runId, the query parameters, the requested platforms, and a per-platform result array. Each platform entry contains its raw answer (when includeRaw: true), parsed citations, and — when extract was provided — brand-mention and domain-citation flags.
Limits and timing
Per-platform timeout: 45 seconds.
Total endpoint budget: 90 seconds. If the orchestrator overruns, the POST returns
504 timeout. The 504 envelope does not include arunId, so retry the POST rather than trying to hydrate a partial run.Concurrency: Up to 4 platforms run in parallel internally.
Brand / domain extraction: Up to 20 entries each.
Partial-failure behaviour
If some platforms succeed and others fail, the response is still 200 OK. Failed platforms appear in failedPlatforms with an error code, and successful platforms appear in results with status: "success".
If all requested platforms fail, the endpoint returns 502 with a top-level runId so you can still hydrate the partial DB state. The body shape is:
Hydrate a previous run
The includeRaw query parameter is optional and defaults to false. The response is the same shape as the POST response.
Error codes
400
invalid_input
Missing or oversized query, unknown platform identifier, duplicate platforms, brands/domains array over 20.
401
unauthorized
Missing or invalid Authorization header.
403
forbidden
API key is missing the search_intelligence:query scope.
404
not_found
runId not found in your org.
429
rate_limited
Per-minute rate limit exceeded.
502
all_platforms_failed
All requested platforms failed. runId is still returned at the top level.
504
timeout
Wall-clock budget (90s) exceeded. The 504 envelope does not return a runId — retry the POST rather than hydrating.
Common gotcha
The endpoint is POST .../search-intelligence/query — not GET .../search-intelligence. A GET on the bare path returns the unknown-route fallthrough; make sure you're posting JSON to the /query sub-path.
Related articles
Getting started with the API — Overview of the agent API and authentication.
Authentication and API keys — How to create keys and add scopes.
Credits, rate limits, and errors — Per-plan rate limits and a full error code reference.
Page Auditor API endpoints — The other recently-published agent endpoint.
Last updated
Was this helpful?