REST API v1 Wszystkie endpointy + przykłady kodu →

API Reference

Ta strona to dokumentacja REST API v1: ponad 400 endpointów, uwierzytelnianie Bearer Token i programowy dostęp do wszystkich funkcji.

Zintegruj generowanie treści AI, analizę SEO, badanie słów kluczowych i zarządzanie treścią ze swoimi aplikacjami. Uwierzytelniaj za pomocą Bearer Tokens przez Laravel Sanctum.

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

Zacznij bezpłatnie — API w planie Free Wszystkie endpointy z przykładami kodu (cURL · Python · PHP · JavaScript)

Połącz w 60 sekund

Jeden token Sanctum, trzy sposoby użycia. Wszystko dostępne w każdym planie — również w planie Free z 50 Credits.

MCP-Server

Każdy endpoint staje się typowanym narzędziem dla Claude i agentów AI.

https://rankion.ai/mcp

Claude-Skill

Plik Markdown, który Claude Code ładuje natywnie.

https://rankion.ai/claude-skill

OpenAPI-Spec

Czytelny maszynowo dla n8n, Zapier, konektora ChatGPT i własnych agentów.

/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

Uwierzytelnianie

Wszystkie żądania API wymagają Bearer Token. Utwórz token w Ustawienia → API Tokens w panelu.

# 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

Uwaga: Do wszystkich żądań dołącz Accept: application/json, a do żądań POST/PUT dodatkowo Content-Type: application/json.

Błędy i kody statusu

Code	Znaczenie
`200`	Sukces
`201`	Zasób utworzony
`202`	Zaakceptowano — uruchomiono przetwarzanie w tle
`204`	Usunięto (brak treści)
`401`	Brak uwierzytelnienia — nieprawidłowy token
`402`	Niewystarczająca liczba Credits
`403`	Brak uprawnień do tego zasobu
`404`	Nie znaleziono zasobu
`422`	Błąd walidacji – proszę sprawdzić parametry
`429`	Osiągnięto limit zapytań
`500`	Błąd serwera

Credit-System

Niektóre endpointy zużywają Credits. Zużycie jest sprawdzane przed wykonaniem. W przypadku niewystarczającego salda otrzymają Państwo błąd 402.

Endpoint	Credits
AI Scanner – wykrywanie	2 Credits
AI Scanner – humanizacja	4+ Credits
Badanie słów kluczowych	5 Credits
Generowanie obrazów	5 Credits
Content Audit	10 Credits
Generowanie artykułów	10+ Credits
Bulk Generation	4 / artykuł
Analiza konkurencji	20 Credits

Team

Pobieranie informacji o bieżącym zespole.

GET /v1/team

Zwraca informacje o zespole wraz z planem, Credits i statystykami.

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

Projects

Zarządzanie projektami. Każdy projekt ma własną domenę, język i Brand Voice.

GET /v1/projects

Lista wszystkich projektów zespołu wraz z Brand Voice.

GET /v1/projects/{project}

Pojedynczy projekt z Brand Voice i ostatnimi 10 artykułami.

POST /v1/projects

Tworzenie nowego projektu.

Parametr	Typ	Info
`name`	string	Wymagany Nazwa projektu
`domain`	string	Opcjonalny URL strony internetowej
`language`	string	Opcjonalny de, en, es, fr (domyślnie: de)
`description`	string	Opcjonalny Opis projektu

# 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}

Aktualizacja projektu. Te same parametry co POST (wszystkie opcjonalne).

DEL /v1/projects/{project}

Usunięcie projektu i wszystkich powiązanych danych. Operacja nieodwracalna.

Articles

Zarządzanie artykułami, ocenianie, optymalizacja i sprawdzanie Freshness.

GET /v1/projects/{project}/articles

Paginowana lista artykułów projektu (20 na stronę).

GET /v1/articles/{article}

Pobieranie pojedynczego artykułu ze wszystkimi szczegółami (treść, wyniki, metadane).

POST /v1/projects/{project}/articles

Ręczne tworzenie nowego artykułu (bez generowania).

Parametr	Typ	Info
`title`	string	Wymagany
`content`	string	Wymagany Treść HTML
`target_keyword`	string	Opcjonalny
`language`	string	Opcjonalny de, en, es, fr
`status`	string	Opcjonalny draft, published

PUT /v1/articles/{article}

Aktualizacja artykułu (title, content, status, meta_title, meta_description, target_keyword).

DEL /v1/articles/{article}

Usunięcie artykułu.

POST /v1/articles/{article}/score

Uruchomienie scoringu SEO jako procesu w tle. Zwraca 202 Accepted.

POST /v1/articles/{article}/optimize

Uruchomienie optymalizacji treści na podstawie URL.

Parametr	Typ	Info
`url`	string	Wymagany URL istniejącego artykułu

GET /v1/articles/{article}/freshness

Sprawdzanie Content Freshness: wiek, wynik, status (fresh/aging/stale/critical).

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

Pobieranie sugestii linkowania wewnętrznego dla artykułu.

Keywords

Zarządzanie słowami kluczowymi i przeprowadzanie badań słów kluczowych opartych na AI.

GET /v1/projects/{project}/keywords

Paginowana lista słów kluczowych projektu.

POST /v1/projects/{project}/keywords

Dodawanie słowa kluczowego.

Parametr	Typ	Info
`keyword`	string	Wymagany min. 2 znaki
`search_volume`	integer	Opcjonalny
`difficulty`	integer	Opcjonalny 0-100
`language`	string	Opcjonalny de, en, es, fr

DEL /v1/keywords/{keyword}

Usuń słowo kluczowe.

POST /v1/keywords/research 5 Credits

Badanie słów kluczowych oparte na AI z wolumenem wyszukiwania i trudnością.

Parametr	Typ	Info
`keyword`	string	Wymagany min. 2 znaki
`language`	string	Opcjonalny de, en, es, fr
`country`	string	Opcjonalny Kod kraju (domyślnie: 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

Zarządzaj wygenerowanymi obrazami.

GET /v1/projects/{project}/images

Wyświetl wszystkie obrazy projektu.

GET /v1/images/{image}

Pobierz pojedynczy obraz z metadanymi.

DEL /v1/images/{image}

Usuń obraz.

Style Profiles

Twórz profile stylu pisania i zarządzaj nimi, aby zachować spójność treści.

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

Wszystkie Style Profiles projektu.

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

Utwórz Style Profile.

Parametr	Typ	Info
`name`	string	Wymagany
`tone`	string	Opcjonalny np. profesjonalny, swobodny, akademicki
`writing_style`	string	Opcjonalny
`vocabulary_level`	string	Opcjonalny
`sentence_structure`	string	Opcjonalny
`rules`	object	Opcjonalny Reguły niestandardowe

PUT /v1/style-profiles/{styleProfile}

Zaktualizuj Style Profile.

DEL /v1/style-profiles/{styleProfile}

Usuń Style Profile.

Knowledge Base

Przesyłaj dokumenty wiedzy używane jako kontekst podczas generowania treści.

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

Wyświetl wszystkie dokumenty Knowledge Base.

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

Utwórz nowy dokument wiedzy.

Parametr	Typ	Info
`title`	string	Wymagany
`content`	string	Wymagany Treść tekstowa
`type`	string	Opcjonalny text, url, pdf

DEL /v1/knowledge-base/{knowledgeDocument}

Usuń dokument wiedzy.

Link Lists

Listy linków do linkowania wewnętrznego i zewnętrznego w generowanych artykułach.

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

Wszystkie listy linków projektu.

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

Utwórz listę linków.

Parametr	Typ	Info
`name`	string	Wymagany
`links`	array	Wymagany Tablica z {url, anchor_text, description}

DEL /v1/link-lists/{linkList}

Usuń listę linków.

Goals

Definiuj cele treści uwzględniane podczas generowania.

GET /v1/goals

Wyświetl wszystkie Goals (systemowe + własne).

POST /v1/goals

Utwórz własny Goal.

Parametr	Typ	Info
`name`	string	Wymagany
`description`	string	Opcjonalny
`prompt_instructions`	string	Opcjonalny Instrukcje AI
`metrics`	object	Opcjonalny Metryki

DEL /v1/goals/{goal}

Usuń własny Goal (Goals systemowe są chronione).

Kalendarz redakcyjny

Zarządzaj kalendarzem redakcyjnym do planowania treści.

GET /v1/projects/{project}/calendar

Wyświetl wpisy kalendarza. Opcjonalnie filtruj za pomocą ?from=2026-01-01&to=2026-03-31.

POST /v1/projects/{project}/calendar

Utwórz wpis kalendarza.

Parametr	Typ	Info
`title`	string	Wymagany
`planned_date`	date	Wymagany YYYY-MM-DD
`status`	string	Opcjonalny planned, in_progress, published
`notes`	string	Opcjonalny

PUT /v1/calendar/{entry}

Zaktualizuj wpis kalendarza.

DEL /v1/calendar/{entry}

Usuń wpis kalendarza.

AI Scanner

Wykrywaj i humanizuj teksty generowane przez AI.

POST /v1/ai-scanner/detect 2 Credits

Analizuj tekst pod kątem generowania przez AI.

Parametr	Typ	Info
`text`	string	Wymagany min. 50 znaków
`scan_type`	string	Opcjonalny quick, deep (domyślnie: quick)

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

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

Humanizacja artykułu (proces w tle, 202 Accepted).

Parametr	Typ	Info
`article_id`	integer	Wymagany
`level`	string	Opcjonalny light, medium, aggressive

Content Audit

Automatyczna analiza i ocena treści witryny.

GET /v1/content-audits

Lista wszystkich Content Auditów zespołu.

POST /v1/content-audits 10 Credits

Uruchomienie nowego Content Auditu (proces w tle).

Parametr	Typ	Info
`source_url`	string	Wymagany URL analizowanej witryny
`type`	string	Opcjonalny full, quick

GET /v1/content-audits/{audit}

Pobieranie pojedynczego audytu ze wszystkimi przeanalizowanymi stronami.

Analiza konkurencji

Analiza konkurentów i identyfikacja luk w treści.

GET /v1/competitor-analyses

Lista wszystkich analiz konkurencji.

POST /v1/competitor-analyses 20 Credits

Uruchomienie nowej analizy konkurencji.

Parametr	Typ	Info
`project_id`	integer	Wymagany
`domain`	string	Wymagany Domena bez protokołu
`language`	string	Opcjonalny de, en, es, fr
`competitor_limit`	integer	Opcjonalny maks. liczba konkurentów

GET /v1/competitor-analyses/{analysis}

Pobieranie wyników analizy z konkurentami i lukami w treści.

AI Visibility Tracking

Monitorowanie widoczności Państwa domeny w wyszukiwarkach AI (ChatGPT, Perplexity, Gemini).

GET /v1/tracking-projects

Lista wszystkich projektów śledzenia z wynikami.

GET /v1/tracking-projects/{trackingProject}

Pojedynczy projekt śledzenia z historią widoczności i szczegółami słów kluczowych.

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

Ręczne uruchomienie przebiegu śledzenia (proces w tle).

Generowanie treści

Generowanie artykułów i obrazów za pomocą AI.

POST /v1/generate/article 10+ Credits

Generowanie artykułu AI (proces w tle, 202 Accepted).

Parametr	Typ	Info
`project_id`	integer	Wymagany
`keyword`	string	Wymagany Główne słowo kluczowe
`type`	string	Opcjonalny blog-post, guide, listicle, review, comparison, pillar
`length`	integer	Opcjonalny 300–5000 słów (domyślnie: 1500)
`tone`	string	Opcjonalny np. professional, casual
`language`	string	Opcjonalny 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

Generowanie obrazu AI (proces w tle, 202 Accepted).

Parametr	Typ	Info
`project_id`	integer	Wymagany
`prompt`	string	Wymagany Opis obrazu
`style`	string	Opcjonalny photo, illustration, 3d, watercolor

Bulk Generation

Generowanie wielu artykułów jednocześnie.

GET /v1/bulk-generations

Lista wszystkich generowań zbiorczych ze statusem.

POST /v1/bulk-generations 4 / artykuł

Uruchomienie generowania zbiorczego.

Parametr	Typ	Info
`project_id`	integer	Wymagany
`keywords`	array	Wymagany Tablica słów kluczowych
`settings`	object	Opcjonalny {type, length, tone, language}

GET /v1/bulk-generations/{bulk}

Pobieranie statusu generowania zbiorczego z poszczególnymi elementami.

Autopilot

Konfiguracja automatycznego generowania treści według harmonogramu.

GET /v1/autopilot

Lista wszystkich harmonogramów autopilota.

POST /v1/autopilot

Tworzenie harmonogramu autopilota.

Parametr	Typ	Info
`project_id`	integer	Wymagany
`name`	string	Wymagany
`frequency`	string	Wymagany daily, weekly, biweekly, monthly
`keyword_source`	string	Opcjonalny manual, keyword_list, ai_suggest
`keywords`	array	Opcjonalny Dla trybu manual: tablica słów kluczowych
`settings`	object	Opcjonalny {type, length, tone}

PUT /v1/autopilot/{schedule}

Aktualizacja harmonogramu. Dodatkowo: is_active (boolean) do włączania/wyłączania.

DEL /v1/autopilot/{schedule}

Usunięcie harmonogramu.

Credits

Sprawdzanie salda i historii Credits.

GET /v1/credits

Pobieranie aktualnego salda i planu.

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

GET /v1/credits/history

Stronicowana historia Credits (20 wpisów na stronę).

Blog (Admin)

Zarządzanie kategoriami i wpisami bloga.

Kategorie

GET /v1/blog/categories

Wyświetl wszystkie kategorie bloga.

POST /v1/blog/categories

Utwórz kategorię.

Parametr	Typ	Info
`name`	string	Wymagany
`slug`	string	Opcjonalny (generowane automatycznie)
`description`	string	Opcjonalny

PUT /v1/blog/categories/{category}

Zaktualizuj kategorię.

DEL /v1/blog/categories/{category}

Usuń kategorię.

Posts

GET /v1/blog/posts

Wyświetl wszystkie wpisy bloga (paginacja).

GET /v1/blog/posts/{post}

Pobierz pojedynczy wpis bloga.

POST /v1/blog/posts

Utwórz wpis bloga.

Parametr	Typ	Info
`title`	string	Wymagany
`content`	string	Wymagany
`category_id`	integer	Opcjonalny
`status`	string	Opcjonalny draft, published
`locale`	string	Opcjonalny de, en, es, fr

PUT /v1/blog/posts/{post}

Zaktualizuj wpis bloga.

DEL /v1/blog/posts/{post}

Usuń wpis bloga.

Health Check

Publiczny endpoint (bez tokena) do monitorowania.

GET /api/health

Zwraca status serwera. Uwierzytelnianie nie jest wymagane.

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

Gotowi, aby korzystać z API?

Utwórz bezpłatne konto, pobierz token w Ustawienia → API i zacznij działać. 50 Credits gratis, bez karty kredytowej.

Zacznij bezpłatnie — API w planie Free Wszystkie endpointy z przykładami kodu (cURL · Python · PHP · JavaScript)