v1 · OpenAPI 3.0.3

API Reference

The full REST surface, grouped by capability. Every endpoint is described by the machine-readable OpenAPI spec — point your generator, Postman, or an LLM at it.

OpenAPI spec

The complete, always-current spec lives at /api/openapi.json. The server URL adapts to the request origin, so it works in production and on localhost unchanged.

bash
# Fetch the spec
curl https://www.seoladders.com/api/openapi.json

# Or import it into Postman / an OpenAPI client / an agent

Base URL & auth

All paths are under /api/v1 and require a bearer token. See Authentication.

bash
curl https://www.seoladders.com/api/v1/projects \
  -H "Authorization: Bearer sk_live_••••"

Endpoints by capability

The same grouping the dashboard and the MCP tools use. Request and response shapes for each are in the OpenAPI spec.

Topics

Topical authority — clusters, keyword coverage, and tracked prompts.

  • GET/POST /topics
  • GET/PATCH/DELETE /topics/{id}
  • POST /topics/{id}/research
  • POST /topics/{id}/keywords · DELETE /topics/{id}/keywords/{keywordId}
  • GET/POST /topics/{id}/prompts · DELETE /topics/{id}/prompts/{promptId}
Research

Keywords, rankings, Search Console and site audits.

  • POST /keywords/search · /keywords/discover · /keywords/competitor-gap
  • GET /rankings
  • GET /search-console
  • POST/GET /audit
Content

Posts, content calendar, knowledge base and Content Radar.

  • GET /posts
  • GET/POST /calendar
  • GET/POST /knowledge
  • GET /content-radar · POST /content-radar/recommendations
Articles

Generate, fetch and publish articles.

  • POST /articles · POST /articles/batch
  • GET /articles/{id} · POST /articles/{id}/publish
  • GET /batches/{id}
Optimizer

Rewrite any URL against the live top-5 SERP.

  • POST /optimizations · GET /optimizations/{id}
AI Visibility

GEO — score, citations, sentiment, sources, gaps, prompts, competitors.

  • GET /ai-visibility · /ai-visibility/citations · /sentiment · /sources
  • GET/POST /ai-visibility/content-gaps
  • GET/POST /prompts · GET /prompts/explorer
  • GET/POST/DELETE /competitors
Link Building

Pages AI cites for your prompts, quality-scored, with a contact and a drafted pitch.

  • GET/POST /link-building
  • PATCH /link-building/{id} · POST /link-building/{id}/followup
Autopilot

Recommended actions and automation toggles.

  • GET /actions
  • POST /settings/auto-publish
  • POST /autoblog/autofill
Account

Sites, integration status and async jobs.

  • GET /projects
  • GET /integrations
  • GET /jobs/{id}
Webhooks

Signing secret and delivery introspection.

  • GET /webhook-secret · POST /webhook-secret/rotate
  • GET /webhook-deliveries · POST /webhook-deliveries/{id}/retry

Prefer tools over raw HTTP?

Every endpoint here is also an MCP tool — see MCP Setup to drive the API from Claude Code, Cursor, Windsurf or Codex.