Documentation
Start with the quickstart, make one successful request, then expand into authentication, SDKs, errors, and the full API surface.
Choose Your Starting Point
Use the docs like a workflow, not a library
Documentation works better when the next action is obvious. These routes match the most common reasons people land here.
First Call
You want one successful request
Start with quickstart if you need the smallest path to a working request and an understandable async job flow.
Implementation
You need auth, SDKs, or endpoint detail
Jump to authentication, SDKs, and API reference when the code path is already chosen and you need exact contract details.
ICP Playbooks
You need the exact workflow chain
Use workflow bundles when the real job is launching, refreshing, monitoring, scaling, or finding competitor gaps.
Workflow Fit
You need to map AgentSEO to a product job
Use cases are the fastest route when the real question is where AgentSEO belongs in your app, agent, or internal workflow.
Prove fit before you read everything
The docs get easier once you know which question you are trying to answer. These proof-heavy routes are the shortest way from documentation into a real decision about tooling, workflow shape, or answer-layer measurement.
You need the workflow bundle
Start with ICP playbooks when the question is which APIs to chain for launch, refresh, AI visibility, programmatic SEO, or competitor gaps.
You are still choosing the API shape
Start with the buyer guide when the real question is raw data API versus SERP API versus workflow API.
You are designing the runtime next
Use the SEO agent guide when the API choice is mostly clear and the next question is safe orchestration.
You need the reporting model
Use the AI visibility guide when the workflow needs citations, prompt sets, and operator reporting.
Quickstart
First successful request, async job shape, and SDK or MCP setup.
Authentication
API keys, hosted MCP auth, allowed domains, and attribution headers.
API Reference
Endpoint-by-endpoint request and response examples for the public API.
Errors
Error envelopes, credits exhaustion, rate limits, and async job failure handling.
Core Workflows
Start with /audit/local, /content/gap, /rank/track, /local-visibility/track, and /ai-overview/extract.
Opportunity Workflows
Use /opportunities/find, /opportunities/brief, and /content/refresh-brief , /content/serp-outline, and /content/brief, and /content/draft-qa, and /content/schema-plan, and /content/internal-links, and /content/title-meta, and /content/technical-qa, and /content/action-plan, and /site/sitemap-audit, and /serp/volatility, and /page/cro-qa, and /ai-visibility/prompt-set, and /content/programmatic-template, and /content/cannibalization, and /content/competitor-gap-matrix, and /content/keyword-map, and /keyword-ideas/suggest, and /keyword-metrics/overview, and /domain/ranked-keywords, and /domain/competitors, and /domain/intersection, and /pages/intersection, and /domain/traffic-estimate, and /backlinks/summary, and /backlinks/new-lost-timeseries, and /backlinks/page-intersection, and /backlinks/opportunity-finder, and /backlinks/list, and /backlinks/anchors, and /backlinks/referring-domains, and /backlinks/domain-pages, and /backlinks/competitors, and /domain/relevant-pages when a marketer or coding agent needs to decide what to create, fix, and edit next.
Agent Workflow Contract
Core workflow responses include agent_workflow with a decision, confidence, evidence, recommended actions, limitations, and next calls.
Supporting Primitives
Use /search, /extract, and /analyze/serp to inspect the evidence before triggering heavier workflows. They now return lightweight agent support fields instead of only raw raw API-shaped output.
For Developers
Install public packages and run your first request with copy-paste quickstarts.
For Product Teams
Understand implementation paths and where AgentSEO fits in agent workflows.
For Vibe Marketers
Pick a packaged workflow for launching, refreshing, monitoring, scaling, or competitor-gap planning before choosing individual endpoints.
Need help?
Get in touch with our team.