REST API v1 Todos los endpoints + ejemplos de código →

Referencia de la API

Esta página es la referencia para desarrolladores de la API REST v1: más de 400 endpoints, autenticación por token Bearer y acceso a todas las funciones.

Integra la generación de contenido con IA, el análisis SEO, la investigación de keywords y la gestión de contenido en tus aplicaciones. Autentícate con tokens Bearer a través de Laravel Sanctum.

# Quick Start curl -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Accept: application/json" \ https://rankion.ai/api/v1/team

Comenzar gratis — API en el plan Free Todos los endpoints con ejemplos de código (cURL · Python · PHP · JavaScript)

Conéctate en 60 segundos

Un token Sanctum, tres formas de acceder. Todo está incluido en todos los planes — incluso en el plan gratuito con 50 créditos.

MCP-Server

Cada endpoint se convierte en una herramienta tipada para Claude y agentes de IA.

https://rankion.ai/mcp

Claude-Skill

Un único archivo markdown que Claude Code carga de forma nativa.

https://rankion.ai/claude-skill

OpenAPI-Spec

Legible por máquina para n8n, Zapier, el conector de ChatGPT y tus propios agentes.

/api/v1/openapi.yaml ↓

# 1) Token holen: Dashboard → Einstellungen → API Tokens # 2) MCP-Server in Claude Code verbinden claude mcp add rankion --transport http https://rankion.ai/mcp \ --header "Authorization: Bearer rk_live_..." # 3) Oder direkt per REST testen (Free-Plan reicht) curl -H "Authorization: Bearer rk_live_..." https://rankion.ai/api/v1/team

Autenticación

Todas las solicitudes a la API requieren un token Bearer. Crea tu token en Ajustes → Tokens de API dentro del panel.

# Jeden Request mit Bearer Token authentifizieren curl -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ https://rankion.ai/api/v1/team

Nota: Envía Accept: application/json en todas las solicitudes y, además, Content-Type: application/json en las solicitudes POST/PUT.

Errores y códigos de estado

Code	Significado
`200`	Éxito
`201`	Recurso creado
`202`	Aceptado – procesamiento en segundo plano iniciado
`204`	Eliminado (sin contenido)
`401`	No autenticado – token inválido
`402`	Créditos insuficientes
`403`	Sin permiso para este recurso
`404`	Recurso no encontrado
`422`	Error de validación – revisa los parámetros
`429`	Límite de solicitudes alcanzado
`500`	Error del servidor

Sistema de créditos

Algunos endpoints consumen créditos. El consumo se verifica antes de la ejecución. Si el saldo es insuficiente, recibirás un error 402.

Endpoint	Credits
AI Scanner – Detección	2 Credits
AI Scanner – Humanización	4+ Credits
Investigación de keywords	5 Credits
Generación de imágenes	5 Credits
Content Audit	10 Credits
Generación de artículos	10+ Credits
Bulk Generation	4 / artículo
Análisis de competidores	20 Credits

Team

Obtén información sobre tu equipo actual.

GET /v1/team

Devuelve la información del equipo con el plan, los créditos y las estadísticas.

// Response 200 { "id": 1, "name": "Mein Team", "plan": "pro", "credit_balance": 5000, "members_count": 3, "projects_count": 5, "articles_count": 120 }

Projects

Gestiona proyectos. Cada proyecto tiene su propio dominio, idioma y voz de marca.

GET /v1/projects

Lista todos los proyectos del equipo con su voz de marca.

GET /v1/projects/{project}

Proyecto individual con voz de marca y los últimos 10 artículos.

POST /v1/projects

Crea un nuevo proyecto.

Parámetro	Tipo	Info
`name`	string	Obligatorio Nombre del proyecto
`domain`	string	Opcional URL del sitio web
`language`	string	Opcional de, en, es, fr (por defecto: de)
`description`	string	Opcional Descripción del proyecto

# Beispiel curl -X POST https://rankion.ai/api/v1/projects \ -H "Authorization: Bearer TOKEN" \ -H "Content-Type: application/json" \ -d '{"name":"Mein Blog","domain":"https://blog.example.com","language":"de"}'

PUT /v1/projects/{project}

Actualiza un proyecto. Mismos parámetros que POST (todos opcionales).

DEL /v1/projects/{project}

Elimina el proyecto y todos los datos asociados. No reversible.

Articles

Gestiona, puntúa, optimiza y comprueba la actualidad de los artículos.

GET /v1/projects/{project}/articles

Lista paginada de los artículos de un proyecto (20 por página).

GET /v1/articles/{article}

Obtén un artículo individual con todos los detalles (contenido, puntuaciones, metadatos).

POST /v1/projects/{project}/articles

Crea un nuevo artículo manualmente (no generado).

Parámetro	Tipo	Info
`title`	string	Obligatorio
`content`	string	Obligatorio Contenido HTML
`target_keyword`	string	Opcional
`language`	string	Opcional de, en, es, fr
`status`	string	Opcional draft, published

PUT /v1/articles/{article}

Actualiza un artículo (title, content, status, meta_title, meta_description, target_keyword).

DEL /v1/articles/{article}

Elimina un artículo.

POST /v1/articles/{article}/score

Inicia la puntuación SEO como proceso en segundo plano. Devuelve 202 Accepted.

POST /v1/articles/{article}/optimize

Inicia la optimización de contenido a partir de una URL.

Parámetro	Tipo	Info
`url`	string	Obligatorio URL del artículo existente

GET /v1/articles/{article}/freshness

Comprueba la actualidad del contenido: antigüedad, puntuación, estado (fresh/aging/stale/critical).

GET /v1/articles/{article}/link-suggestions

Obtén sugerencias de enlazado interno para un artículo.

Keywords

Gestiona keywords y realiza investigación de keywords basada en IA.

GET /v1/projects/{project}/keywords

Lista paginada de las keywords de un proyecto.

POST /v1/projects/{project}/keywords

Añade una keyword.

Parámetro	Tipo	Info
`keyword`	string	Obligatorio mín. 2 caracteres
`search_volume`	integer	Opcional
`difficulty`	integer	Opcional 0-100
`language`	string	Opcional de, en, es, fr

DEL /v1/keywords/{keyword}

Elimina una keyword.

POST /v1/keywords/research 5 Credits

Investigación de keywords basada en IA con volumen de búsqueda y dificultad.

Parámetro	Tipo	Info
`keyword`	string	Obligatorio mín. 2 caracteres
`language`	string	Opcional de, en, es, fr
`country`	string	Opcional Código de país (por defecto: de)

# Beispiel curl -X POST https://rankion.ai/api/v1/keywords/research \ -H "Authorization: Bearer TOKEN" \ -H "Content-Type: application/json" \ -d '{"keyword":"seo optimierung","language":"de"}'

Images

Gestiona las imágenes generadas.

GET /v1/projects/{project}/images

Lista todas las imágenes de un proyecto.

GET /v1/images/{image}

Obtén una imagen individual con sus metadatos.

DEL /v1/images/{image}

Elimina una imagen.

Style Profiles

Crea y gestiona perfiles de estilo de escritura para un contenido consistente.

GET /v1/projects/{project}/style-profiles

Todos los perfiles de estilo de un proyecto.

POST /v1/projects/{project}/style-profiles

Crea un perfil de estilo.

Parámetro	Tipo	Info
`name`	string	Obligatorio
`tone`	string	Opcional p. ej. profesional, informal, académico
`writing_style`	string	Opcional
`vocabulary_level`	string	Opcional
`sentence_structure`	string	Opcional
`rules`	object	Opcional Reglas personalizadas

PUT /v1/style-profiles/{styleProfile}

Actualiza un perfil de estilo.

DEL /v1/style-profiles/{styleProfile}

Elimina un perfil de estilo.

Knowledge Base

Sube documentos de conocimiento que se usan como contexto durante la generación de contenido.

GET /v1/projects/{project}/knowledge-base

Lista todos los documentos de la base de conocimiento.

POST /v1/projects/{project}/knowledge-base

Crea un nuevo documento de conocimiento.

Parámetro	Tipo	Info
`title`	string	Obligatorio
`content`	string	Obligatorio Contenido de texto
`type`	string	Opcional text, url, pdf

DEL /v1/knowledge-base/{knowledgeDocument}

Elimina un documento de conocimiento.

Link Lists

Listas de enlaces para el enlazado interno y externo en artículos generados.

GET /v1/projects/{project}/link-lists

Todas las listas de enlaces de un proyecto.

POST /v1/projects/{project}/link-lists

Crea una lista de enlaces.

Parámetro	Tipo	Info
`name`	string	Obligatorio
`links`	array	Obligatorio Array de {url, anchor_text, description}

DEL /v1/link-lists/{linkList}

Elimina una lista de enlaces.

Goals

Define objetivos de contenido que se tienen en cuenta durante la generación.

GET /v1/goals

Lista todos los objetivos (del sistema y propios).

POST /v1/goals

Crea un objetivo propio.

Parámetro	Tipo	Info
`name`	string	Obligatorio
`description`	string	Opcional
`prompt_instructions`	string	Opcional Instrucciones de IA
`metrics`	object	Opcional Métricas

DEL /v1/goals/{goal}

Elimina un objetivo propio (los objetivos del sistema están protegidos).

Calendario editorial

Gestiona el calendario editorial para la planificación de contenido.

GET /v1/projects/{project}/calendar

Lista las entradas del calendario. Filtra opcionalmente con ?from=2026-01-01&to=2026-03-31.

POST /v1/projects/{project}/calendar

Crea una entrada de calendario.

Parámetro	Tipo	Info
`title`	string	Obligatorio
`planned_date`	date	Obligatorio YYYY-MM-DD
`status`	string	Opcional planned, in_progress, published
`notes`	string	Opcional

PUT /v1/calendar/{entry}

Actualiza una entrada de calendario.

DEL /v1/calendar/{entry}

Elimina una entrada de calendario.

AI Scanner

Detecta y humaniza textos generados por IA.

POST /v1/ai-scanner/detect 2 Credits

Analiza un texto para detectar generación por IA.

Parámetro	Tipo	Info
`text`	string	Obligatorio mín. 50 caracteres
`scan_type`	string	Opcional quick, deep (por defecto: quick)

// Response 200 { "score": 85, "scan_type": "quick", "word_count": 250, "details": { ... } }

POST /v1/ai-scanner/humanize 4+ Credits

Humaniza un artículo (proceso en segundo plano, 202 Accepted).

Parámetro	Tipo	Info
`article_id`	integer	Obligatorio
`level`	string	Opcional light, medium, aggressive

Content Audit

Analiza y puntúa automáticamente el contenido de un sitio web.

GET /v1/content-audits

Lista todas las auditorías de contenido del equipo.

POST /v1/content-audits 10 Credits

Inicia una nueva auditoría de contenido (proceso en segundo plano).

Parámetro	Tipo	Info
`source_url`	string	Obligatorio URL del sitio web a analizar
`type`	string	Opcional full, quick

GET /v1/content-audits/{audit}

Obtén una auditoría individual con todas las páginas analizadas.

Análisis de competidores

Analiza competidores e identifica brechas de contenido.

GET /v1/competitor-analyses

Lista todos los análisis de competidores.

POST /v1/competitor-analyses 20 Credits

Inicia un nuevo análisis de competidores.

Parámetro	Tipo	Info
`project_id`	integer	Obligatorio
`domain`	string	Obligatorio Dominio sin protocolo
`language`	string	Opcional de, en, es, fr
`competitor_limit`	integer	Opcional núm. máx. de competidores

GET /v1/competitor-analyses/{analysis}

Obtén el resultado del análisis con competidores y brechas de contenido.

AI Visibility Tracking

Supervisa la visibilidad de tu dominio en motores de búsqueda de IA (ChatGPT, Perplexity, Gemini).

GET /v1/tracking-projects

Lista todos los proyectos de seguimiento con sus puntuaciones.

GET /v1/tracking-projects/{trackingProject}

Proyecto de seguimiento individual con historial de visibilidad y detalles de keywords.

POST /v1/tracking-projects/{trackingProject}/run

Inicia una ejecución de seguimiento manual (proceso en segundo plano).

Generación de contenido

Genera artículos e imágenes con IA.

POST /v1/generate/article 10+ Credits

Genera un artículo con IA (proceso en segundo plano, 202 Accepted).

Parámetro	Tipo	Info
`project_id`	integer	Obligatorio
`keyword`	string	Obligatorio Keyword principal
`type`	string	Opcional blog-post, guide, listicle, review, comparison, pillar
`length`	integer	Opcional 300-5000 palabras (por defecto: 1500)
`tone`	string	Opcional p. ej. professional, casual
`language`	string	Opcional de, en, es, fr

# Beispiel: Blog-Artikel generieren curl -X POST https://rankion.ai/api/v1/generate/article \ -H "Authorization: Bearer TOKEN" \ -H "Content-Type: application/json" \ -d '{ "project_id": 1, "keyword": "seo optimierung 2026", "type": "guide", "length": 2000, "language": "de" }' // Response 202 { "message": "Article generation queued", "article_id": 42 }

POST /v1/generate/image 5 Credits

Genera una imagen con IA (proceso en segundo plano, 202 Accepted).

Parámetro	Tipo	Info
`project_id`	integer	Obligatorio
`prompt`	string	Obligatorio Descripción de la imagen
`style`	string	Opcional photo, illustration, 3d, watercolor

Bulk Generation

Genera varios artículos a la vez.

GET /v1/bulk-generations

Lista todas las generaciones masivas con su estado.

POST /v1/bulk-generations 4 / artículo

Inicia una generación masiva.

Parámetro	Tipo	Info
`project_id`	integer	Obligatorio
`keywords`	array	Obligatorio Array de keywords
`settings`	object	Opcional {type, length, tone, language}

GET /v1/bulk-generations/{bulk}

Obtén el estado de una generación masiva con los elementos individuales.

Autopilot

Configura la generación automática de contenido según un calendario.

GET /v1/autopilot

Lista todos los calendarios de Autopilot.

POST /v1/autopilot

Crea un calendario de Autopilot.

Parámetro	Tipo	Info
`project_id`	integer	Obligatorio
`name`	string	Obligatorio
`frequency`	string	Obligatorio daily, weekly, biweekly, monthly
`keyword_source`	string	Opcional manual, keyword_list, ai_suggest
`keywords`	array	Opcional Si manual: array de keywords
`settings`	object	Opcional {type, length, tone}

PUT /v1/autopilot/{schedule}

Actualiza el calendario. Además: is_active (boolean) para activar/desactivar.

DEL /v1/autopilot/{schedule}

Elimina el calendario.

Credits

Consulta el saldo y el historial de créditos.

GET /v1/credits

Obtén el saldo actual y el plan.

// Response 200 { "balance": 5000, "plan": "pro" }

GET /v1/credits/history

Historial de créditos paginado (20 entradas por página).

Blog (Admin)

Gestiona las categorías y publicaciones del blog.

Categorías

GET /v1/blog/categories

Lista todas las categorías del blog.

POST /v1/blog/categories

Crea una categoría.

Parámetro	Tipo	Info
`name`	string	Obligatorio
`slug`	string	Opcional (generado automáticamente)
`description`	string	Opcional

PUT /v1/blog/categories/{category}

Actualiza una categoría.

DEL /v1/blog/categories/{category}

Elimina una categoría.

Posts

GET /v1/blog/posts

Lista todas las publicaciones del blog (paginado).

GET /v1/blog/posts/{post}

Obtén una publicación de blog individual.

POST /v1/blog/posts

Crea una publicación de blog.

Parámetro	Tipo	Info
`title`	string	Obligatorio
`content`	string	Obligatorio
`category_id`	integer	Opcional
`status`	string	Opcional draft, published
`locale`	string	Opcional de, en, es, fr

PUT /v1/blog/posts/{post}

Actualiza una publicación de blog.

DEL /v1/blog/posts/{post}

Elimina una publicación de blog.

Health Check

Endpoint público (sin token necesario) para monitorización.

GET /api/health

Devuelve el estado del servidor. No se requiere autenticación.

// Response 200 { "status": "ok", "timestamp": "2026-02-24T12:00:00Z" }

¿Listo para usar la API?

Crea una cuenta gratis, obtén tu token en Ajustes → API y empieza. 50 créditos gratis, sin tarjeta.

Comenzar gratis — API en el plan Free Todos los endpoints con ejemplos de código (cURL · Python · PHP · JavaScript)