Referencia de API — Visión general
API REST con 137 endpoints. Auth Sanctum, JSON, jobs asíncronos vía 202, acciones basadas en créditos.
Rankion ofrece una API REST completa con 137 endpoints bajo la versión v1. Todo lo que puedes hacer desde la interfaz web también lo puedes automatizar por HTTP — generar artículos, monitorizar AI Visibility, traer backlinks, expandir keywords, generar reportes.
- URL base:
https://rankion.ai/api/v1 - Auth: Bearer Token vía Sanctum (ver Autenticación)
- Formato: JSON para todas las requests y responses
- Team-Scoping: Todos los endpoints están scope al team — cualquier acceso cross-team responde
403
Inicio rápido
TOKEN="<tu-sanctum-token>"
BASE="https://rankion.ai/api/v1"
curl -H "Authorization: Bearer $TOKEN" \
-H "Accept: application/json" \
"$BASE/projects"
Response (recortada):
{
"data": [
{ "id": 1, "name": "Mein Projekt", "domain": "example.com" }
],
"meta": { "total": 1, "per_page": 25, "current_page": 1, "last_page": 1 }
}
Temas
- Autenticación y tokens — crear, rotar y revocar Bearer Tokens de Sanctum
- Créditos y rate limits — qué cuesta cuánto, cuándo aparece 402 y dónde están los límites
- Proyectos — CRUD más Tracking-Projects (asistente de AI Visibility)
- Artículos — generar, puntuar, optimizar, repurposar, publicar
Convenciones de respuesta
| Code | Significado |
|---|---|
200 |
Éxito, response JSON |
201 |
Recurso creado |
202 |
Job asíncrono dispatched — la response incluye un ID para hacer polling |
400 / 422 |
Error de validación: {message, errors:{field:[reason]}} |
402 |
Créditos insuficientes — el balance del team no alcanza para la acción |
403 |
IDOR / Team-Mismatch — el token no pertenece al team del recurso |
404 |
Recurso no encontrado (o cross-team oculto — sin fuga de existencia) |
409 |
Conflicto (p. ej. el artículo ya está publicándose) |
429 |
Rate limit superado |
Jobs asíncronos
Todas las acciones que tardan más de ~10 segundos (generación de artículos, expansión de keywords, pull de backlinks, reportes Reality Check, page audits, …) se ejecutan como jobs en cola. Patrón:
- Envías
POST /v1/articles/{id}/generate→ el servidor responde202 Acceptedcon, p. ej.,{article_id, status: "pending"}. - Haces polling a
GET /v1/articles/{id}(o el endpoint de status correspondiente) cada 5 segundos. - Cuando
processing_status == "ready"(ostatus == "completed"), la acción ha terminado.
Patrones concretos de polling (loops curl) los encuentras en las páginas de cada módulo y en el workflow de artículos.
Familias de tools y sus endpoints
| Familia | Cantidad | Top endpoint |
|---|---|---|
| AI Visibility Tracking (proyectos, 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 + render IA) | 3 | POST /v1/page-audit |
| Reports y correlación cross-module | 4 | POST /v1/tracking-projects/{id}/generate-report |
| Wiki, Chat Shares, Plans, Account, Google Integrations | ~20 | GET /v1/wiki/search |
La tabla completa con cada endpoint, esquema de body y coste en créditos vive en la única fuente de verdad docs/API_REFERENCE.md — también disponible como tablas en vivo bajo rankion.ai/settings/api-documentation.
SDKs / Skills
- Skill de Claude
rankion-api— entregamos un skill listo para usar (.claude/skills/rankion-api.md) que Claude Code puede invocar directamente para llamar a los endpoints de Rankion. - Skill compañero
rankion-agent— delega peticiones multi-step completas al Master Agent en lugar de orquestar endpoints individuales. Ver Agentic Chat. - Servidor MCP — el Master Agent es accesible como servidor MCP para AI agents (
POST /v1/agentic/chat). Con un único endpoint llegas a más de 12 meta-tools.
Continúa con Autenticación.