AI overview extraction

post/ai-overview/extract

Request

  • Base URL: https://www.agentseo.dev/api/v1
  • URL: https://www.agentseo.dev/api/v1/ai-overview/extract
  • Auth: API key in header x-api-key

Query parameters

syncboolean

Open a short inline processing window when supported by the endpoint. If the result is not ready yet, the endpoint may still return 202 with a queued payload that includes poll_url, events_url, and retry_after_seconds.

Headers

x-project-idstring

Optional attribution label for grouping usage and jobs by project.

x-workflow-idstring

Optional attribution label for grouping usage and jobs by workflow or agent run.

Request body

keywordstring required
locationstring
location_codeinteger

Optional search location code for deterministic geo-targeting.

languagestring
target_domainstring

Optional domain to check against the sampled citation candidates.

Response

Completed AI overview workflow with agent_workflow

keywordstring
locationstring
target_domainstring nullable
ai_overview_detectedboolean
overview_status'detected' | 'not_detected'
markdown_summarystring

Changes

No recorded changes to this operation across all 1 revision of this API.