Documentation
Everything you need to integrate with the On-Page SEO API. Start with the quickstart to make your first API call, then explore the reference guides as you build.
Interactive API Reference
Try every endpoint in your browser →
Paste your API key, hit an endpoint, see a live response. Generated from the same contract that serves OpenAPI 3.1 + SDK generators.
Recommended path
1. Quickstart — make your first API call and get a report back.
2. REST API Reference — learn every endpoint, request shape, and error code.
3. Report Schema — understand the 100kb+ JSON report your scans return.
4. Webhooks & Rate Limits — production essentials.
5. MCP Integration — let AI agents run scans and optimizations directly.
Learn by doing
Build an internal linking tool
Submit a scan, retrieve candidate source pages, and turn the response into a review queue for your CMS. Start with cURL, JavaScript, or Python examples and real response data.
Follow the internal-linking tutorialBuild an SEO content optimizer
Turn competitor evidence into prioritized content suggestions, connect them to an editor, and compare the page after an update. Follow examples in cURL, JavaScript, or Python.
Follow the content-optimization tutorialGenerate a client-ready SEO audit PDF
Build a branded report with reviewed recommendations and supporting evidence. Start with a real sample and complete Node.js or Python generators.
Follow the audit PDF tutorialBuild an SEO audit workflow in n8n
Import a working automation that submits a scan, follows the job, and creates a content review queue. Try the saved-data demo first.
Follow the n8n audit tutorialBuild an information-gain research queue
Turn originality signals into research tasks with an explicit reader decision, method, and evidence requirements.
Follow the information-gain tutorialAll guides
Report explorer
Explore real findings, inspect their JSON fields, and see which decisions they support.
Entity coverage and missing topics
Distinguish missing terms from present wording and prioritize useful gaps.
Batch processing
Run bounded workers, respect rate limits, and resume saved jobs after interruptions.
Quickstart
Start hereGo from signup to your first scan, poll, and report with copy-paste commands.
REST API Reference
Endpoint-by-endpoint request shapes, response examples, auth, errors, and code samples.
Authentication
Bearer API keys, permissions, organization scoping, and security best practices.
Report Schema
Understand the scan report layout, what each section means, and how to use the data for SEO.
Webhooks
Signed webhook delivery, retry behavior, health states, and test deliveries.
Rate Limits
Request limits, concurrent scan caps, queue behavior, and how to handle 429s.
MCP Integration
Install the MCP connector for Claude, Cursor, or Codex and let AI agents run scans directly.
SDK Generators
Generate a typed client (TypeScript, Python, and more) from our OpenAPI spec in one command.