REST-API

Auf Ihren Skimle-Projekten aufbauen

Ein einziger Endpunkt je Richtung – Lesen oder Schreiben – für jede Projektressource. Authentifizieren Sie sich mit einem projektbezogenen API-Schlüssel, senden Sie eine Aktion als JSON und erhalten Sie JSON zurück.

In drei Schritten loslegen

Von null bis zum ersten authentifizierten Aufruf.

Einen API-Schlüssel anlegen

API-Schlüssel gelten für ein einzelnes Projekt und eine einzige Zugriffsstufe (Lesen oder Bearbeiten).

1. Öffnen Sie die Seite mit den API-Schlüsseln
2. Wählen Sie das Projekt, auf das der Schlüssel zugreifen soll, und entscheiden Sie zwischen Lese- und Bearbeitungszugriff
3. Kopieren Sie den Schlüssel – Skimle speichert nur seinen Hash

Kopieren Sie den Schlüssel sofort.

Der vollständige Schlüsselwert wird nur einmal beim Anlegen angezeigt. Nachdem Sie das Fenster geschlossen haben, bleibt bei uns nur der Hash – ein verlorener Schlüssel muss neu ausgestellt werden.

Die erste Anfrage senden

Übergeben Sie den Schlüssel als Bearer-Token und die Aktion im JSON-Body. Jeder Endpunkt nimmt JSON entgegen und gibt JSON zurück.

curl -X POST https://app.skimle.com/api/skimle-read \
  -H "Authorization: Bearer skm_…r" \
  -H "Content-Type: application/json" \
  -d '{ "action": "get_categories" }'

Leseschlüssel enden auf r und können nur /api/skimle-read aufrufen. Bearbeitungsschlüssel enden auf e und können beide Endpunkte aufrufen.

Die API-Referenz öffnen

Sehen Sie sich jeden Endpunkt mit Beschreibung, Aufbau der Anfrage und einem Testbereich an. Jede Route nimmt einen Body als unterschiedene Union entgegen, geschlüsselt über action.

Referenz öffnen Endpunkte zum Lesen →Endpunkte zum Schreiben →

Die rohe OpenAPI-3.1-Spezifikation finden Sie unter /api/openapi.json.

Bereit zum Loslegen?

Verwalten Sie Ihre Projektschlüssel, oder sehen Sie sich den MCP-Server für agentische Clients an.

API-Schlüssel anlegen Stattdessen MCP nutzen