API Reference — Overview

Rankion ships a full REST API with 137 endpoints under version v1. Anything you can click in the web UI you can also automate over HTTP — generate articles, track AI visibility, pull backlinks, expand keywords, build reports.

• Base URL: https://rankion.ai/api/v1
• Auth: Bearer token via Sanctum (see Authentication)
• Format: JSON for all requests and responses
• Team scoping: every endpoint is team-scoped — cross-team access returns 403

Quick start

TOKEN="<your-sanctum-token>"
BASE="https://rankion.ai/api/v1"

curl -H "Authorization: Bearer $TOKEN" \
     -H "Accept: application/json" \
     "$BASE/projects"

Response (truncated):

{
  "data": [
    { "id": 1, "name": "My Project", "domain": "example.com" }
  ],
  "meta": { "total": 1, "per_page": 25, "current_page": 1, "last_page": 1 }
}

Topics

• Authentication & Tokens — create, rotate, and revoke Sanctum bearer tokens
• Credits & Rate Limits — what costs how much, when 402 hits, where the limits are
• Projects — CRUD plus tracking projects (AI visibility wizard)
• Articles — generate, score, optimize, repurpose, publish

Response conventions

Async jobs

Any action longer than ~10 seconds (article generation, keyword expansion, backlink pull, reality-check reports, page audits, …) runs as a queue job. Pattern:

1. You send POST /v1/articles/{id}/generate → server replies 202 Accepted with, for example, {article_id, status: "pending"}.
2. You poll GET /v1/articles/{id} (or the matching status endpoint) every 5 seconds.
3. As soon as processing_status == "ready" (or status == "completed") the action is finished.

Concrete polling patterns (curl loops) are in the module pages and the article workflow.

Tool families and their endpoints

The full table with every endpoint, body schema, and credit cost lives in the single source of truth docs/API_REFERENCE.md — also as live tables under rankion.ai/settings/api-documentation.

SDKs / Skills

• Claude skill rankion-api — we ship a ready-to-use skill (.claude/skills/rankion-api.md) that Claude Code can use directly to call Rankion endpoints.
• Companion skill rankion-agent — delegates entire multi-step requests to the master agent instead of orchestrating individual endpoints. See Agentic Chat.
• MCP server — the master agent is exposed as an MCP server for AI agents (POST /v1/agentic/chat). One endpoint is enough to reach more than 12 meta tools.

Continue with Authentication.