API-Referenz — Übersicht
REST-API mit 137 Endpoints. Sanctum-Auth, JSON, async Jobs via 202, Credit-basierte Aktionen.
Rankion liefert eine vollständige REST-API mit 137 Endpoints unter Version v1. Alles was du im Web-UI klicken kannst, kannst du auch per HTTP automatisieren — Artikel generieren, AI-Visibility tracken, Backlinks pullen, Keywords expandieren, Reports erzeugen.
- Base-URL:
https://rankion.ai/api/v1 - Auth: Bearer-Token via Sanctum (siehe Authentifizierung)
- Format: JSON für alle Requests und Responses
- Team-Scoping: Alle Endpoints sind team-scoped — Cross-Team-Zugriff liefert
403
Schnellstart
TOKEN="<dein-sanctum-token>"
BASE="https://rankion.ai/api/v1"
curl -H "Authorization: Bearer $TOKEN" \
-H "Accept: application/json" \
"$BASE/projects"
Response (gekürzt):
{
"data": [
{ "id": 1, "name": "Mein Projekt", "domain": "example.com" }
],
"meta": { "total": 1, "per_page": 25, "current_page": 1, "last_page": 1 }
}
Themen
- Authentifizierung & Tokens — Sanctum-Bearer-Tokens erstellen, rotieren, widerrufen
- Credits & Rate-Limits — Was kostet wieviel, wann kommt 402, wo sind die Limits
- Projekte — CRUD plus Tracking-Projekte (AI-Visibility-Wizard)
- Artikel — Generieren, scoren, optimieren, repurposen, publishen
Antwort-Konventionen
| Code | Bedeutung |
|---|---|
200 |
Erfolg, JSON-Response |
201 |
Resource angelegt |
202 |
Async-Job dispatched — Response enthält ID zum Pollen |
400 / 422 |
Validation Error: {message, errors:{field:[reason]}} |
402 |
Insufficient credits — Team-Balance reicht nicht für die Aktion |
403 |
IDOR / Team-Mismatch — der Token gehört nicht zum betroffenen Team |
404 |
Resource nicht gefunden (oder Cross-Team versteckt — kein Existenz-Leak) |
409 |
Conflict (z.B. Artikel ist bereits am Publishen) |
429 |
Rate-Limit überschritten |
Async Jobs
Alle länger als ~10 Sekunden laufenden Aktionen (Artikel-Generierung, Keyword-Expansion, Backlink-Pull, Reality-Check-Reports, Page-Audits, …) laufen als Queue-Jobs. Pattern:
- Du schickst
POST /v1/articles/{id}/generate→ Server antwortet202 Acceptedplus z.B.{article_id, status: "pending"}. - Du pollst
GET /v1/articles/{id}(oder den jeweiligen Status-Endpoint) im 5-Sekunden-Takt. - Sobald
processing_status == "ready"(bzw.status == "completed") ist die Aktion fertig.
Konkrete Polling-Patterns (curl-Loops) findest du in den Modul-Seiten und im Artikel-Workflow.
Tool-Familien & ihre Endpoints
| Familie | Anzahl | Top-Endpoint |
|---|---|---|
| AI Visibility Tracking (Projekte, Keywords, Prompts, Cited-Sources, Insights, Reality Check) | ~30 | POST /v1/tracking-projects/analyze |
| Articles (CRUD, Generate, Score, Optimize, Repurpose, Publish, Versions, Freshness) | ~17 | POST /v1/articles/{id}/generate |
| SEO Suite (Rank-Tracker, Explorer, Gap, Site-Audit, Backlinks) | ~30 | POST /v1/explorer |
| Keywords (Research & Expansion) | 6 | POST /v1/keywords/research |
| Content Intelligence (Storylines, Style-Profiles, Knowledge-Base, Orphan-Scans) | ~14 | POST /v1/projects/{p}/orphan-scans/discover |
| Image Gallery (CRUD, Edit, Share, Bulk) | ~15 | POST /v1/images/{id}/edit |
| AI Tools (Agentic Chat, AI-Scanner, Humanizer, Content-Optimizer) | ~10 | POST /v1/agentic/chat |
| Competitor / Audit / Community / Site-Monitor | ~15 | POST /v1/content-audits |
| Automation (Bulk, Autopilot, Pipelines) | ~10 | POST /v1/bulk-generations |
| Page-Deep-Audit (Vision + KI-Render) | 3 | POST /v1/page-audit |
| Reports & Cross-Module Correlation | 4 | POST /v1/tracking-projects/{id}/generate-report |
| Wiki, Chat-Shares, Plans, Account, Google-Integrations | ~20 | GET /v1/wiki/search |
Die vollständige Tabelle mit jedem Endpoint, Body-Schema und Credit-Kosten liegt in der Single Source of Truth docs/API_REFERENCE.md — auch als Live-Tabellen unter rankion.ai/settings/api-documentation.
SDKs / Skills
- Claude-Skill
rankion-api— wir liefern einen einsatzfertigen Skill (.claude/skills/rankion-api.md), den Claude Code direkt benutzen kann, um Rankion-Endpoints zu callen. - Companion-Skill
rankion-agent— delegiert komplette Multi-Step-Anfragen an den Master-Agent statt einzelne Endpoints zu orchestrieren. Siehe Agentic Chat. - MCP-Server — der Master-Agent ist als MCP-Server für AI-Agents nutzbar (
POST /v1/agentic/chat). Damit reicht ein einziger Endpoint, um über 12 Meta-Tools zu erreichen.
Weiter mit Authentifizierung.