On‑Page.ai
Dashboard

Quickstart

Go from signup to your first SEO report in a few minutes. This guide walks through the fastest path: create a key, run a scan, and fetch the results.

1

Sign up and complete onboarding

Create your account. Your first organization is created automatically during onboarding, and every API key and scan is scoped to it.

2

Create an API key

Go to Dashboard → API Keys, generate a key, and copy it immediately. You won't see it again.

3

Check your credits

Confirm you have enough balance. New accounts start with 10 free credits — enough for 5 standard scans.

4

Run your first scan

POST /v1/scan with a URL and keyword. You get back a job ID immediately — the scan runs in the background.

5

Poll for completion

GET /v1/jobs/:id every few seconds. When status is "completed", the report is ready. Scans typically take 30 seconds to 2 minutes.

6

Fetch your report

GET /v1/jobs/:id/result returns the full SEO report — entity coverage, related-entity density, competitor analysis, internal linking, and more.

Try it now

Replace op_live_your_key with your real API key and run these in order.

Check your balance

curl -sS "https://api.on-page.ai/v1/credits" \
  -H "Authorization: Bearer op_live_your_key"

Submit a scan

curl -sS -X POST "https://api.on-page.ai/v1/scan" \
  -H "Authorization: Bearer op_live_your_key" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: seo-audit-redding-001" \
  -d '{
    "url": "https://www.memorycare.com/communities/california/redding-ca",
    "keyword": "memory care redding ca",
    "region": "US",
    "locale": "en-US"
  }'

Poll for progress

curl -sS "https://api.on-page.ai/v1/jobs/$JOB_ID" \
  -H "Authorization: Bearer op_live_your_key"

Fetch the report

curl -sS "https://api.on-page.ai/v1/jobs/$JOB_ID/result" \
  -H "Authorization: Bearer op_live_your_key"

What the report gives you

The scan report is organized for action. Here's what you can do with it:

Find missing entities

See which topics your competitors cover that your page doesn't. Add them to close the gap.

Fix internal linking

Get specific recommendations for internal links — source pages, anchor text, and target URLs.

Close authority gaps

Discover which who/what/where/how questions your page should answer but doesn't.

Benchmark against competitors

Compare your page's scores against the top 10 ranking results for your keyword.

Read the full report schema

What's next?

Set up the MCP connector to let Claude, Cursor, or Codex run scans directly from your editor.

Add webhooks so you get notified when scans complete instead of polling.

Read the full API reference for every endpoint, error code, and response shape.