Documentation

Every module, documented

Guides for setting up sites, running crawls, reading audits and integrating with the REST API. Structured docs ship with each module — the surface is finalized here.

  • Quick start
  • REST API reference
  • CLI & webhooks

Quick start

Add your first site, verify it, and run your first crawl in under five minutes.

Authentication

API keys, scopes and workspace permissions for humans and machines.

Crawl config

Crawl depth, budgets, robots handling and SSRF safety rules explained.

Webhooks & exports

Events for audit runs, verification and ranking changes — ready to automate.

14 topics found

The API is documented like a product

Token-based, versioned and white-label friendly. Here is the same one-page check the dashboard runs, from your own code.

# Check a single URL with the Pylon API
curl https://api.pylonseo.io/v1/scan \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://yoursite.com/products/best-tool"}'

# Response (abridged)
{
  "url": "https://yoursite.com/products/best-tool",
  "score": 78,
  "checks": {
    "title": { "status": "pass" },
    "canonical": { "status": "warn", "detail": "Previous canonical differs on http host" }
  }
}

Illustrative request — the endpoint contract ships with the scanner as it is exposed publicly.

Start with the five-minute quick start

Add a site, verify it, and run your first crawl before your coffee cools — free for 7 days, no credit card.

FAQ

Questions, answered

Straight answers about how this module works and what it unlocks.

Structured docs ship module-by-module as each engine is exposed — the surface above is the final index. Quick-start and audit-reading guides land with the crawl features already live.

Both — workspace API keys for machines and bearer tokens for app sessions, with scopes that keep read-only automation read-only. Authentication docs roll out with the API.

Yes — the REST API and webhooks are designed for scripted workflows. Webhook events cover audit runs, verifications and ranking changes, with signed payloads defined in the reference.

The index, routes and claims here are finalized and mirrored in the app. Article depth grows per module, but the surface never drifts from what the product actually exposes.

Still have questions?

Try the platform free for 7 days, or read the docs — the answer is usually one click away.

Page structure live. Content lands module-by-module; the section structure and routes are final.