REST / v1
Find the endpoint.
Build the next step.
Request parameters and examples for 58 operations. Open a task-specific reference to read or copy only what your implementation needs.
Base URL: https://www.agentseo.dev/api/v1
Authentication: x-api-key: YOUR_API_KEY
OpenAPI specification · First request · Async response lifecycle
Understand the response before chaining calls
Most analysis POST requests return 202 with a jobId, poll_url, events_url, and retry_after_seconds. Read the completed job’s result. A failed job has an error you should inspect.
Supported ?sync=true requests can still return a queued job. Extraction and webhook management are synchronous; local audit batches return multiple job IDs. Geo-targeted endpoints prefer location_code over a conflicting location name.
Browse by task
Search & extraction →
Search results, page extraction, and SERP analysis.
Content & page quality →
Briefs, content gaps, on-page checks, internal links, and publishing decisions.
- POST
/content/gap - POST
/content/refresh-brief - POST
/content/serp-outline - POST
/content/brief - POST
/content/draft-qa - POST
/content/schema-plan - POST
/content/internal-links - POST
/content/title-meta - POST
/content/keyword-map - POST
/content/technical-qa - POST
/content/action-plan - POST
/site/sitemap-audit - POST
/serp/volatility - POST
/page/cro-qa - POST
/content/cannibalization - POST
/content/competitor-gap-matrix - POST
/content/programmatic-template - POST
/content-decay/detect
Rank & AI visibility →
Rank history, local audits, AI Overview evidence, and mention tracking.
Keywords & competitors →
Keyword ideas, metrics, clustering, domain comparisons, and traffic estimates.
Backlinks →
Link profiles, referring domains, intersections, and outreach opportunities.
Opportunities & signals →
Find opportunities, prepare briefs, and inspect social demand signals.
Jobs & webhooks →
Poll results, stream job events, and manage webhook delivery.