REST-API

Auf Ihren Skimle-Projekten aufbauen

JSON-Endpunkte zum Lesen und Schreiben von Projektdaten und zum Durchführen eines Projekts von Anfang bis Ende. Authentifizieren Sie sich mit einem Bearer-Schlüssel, senden Sie eine Aktion und erhalten Sie JSON zurück.

In drei Schritten loslegen

Von null bis zum ersten authentifizierten Aufruf.

Einen API-Schlüssel anlegen

Ein Projektschlüssel erreicht ein Projekt. Ein Kontoschlüssel erreicht ein Team und kann darin Projekte anlegen. Beide gibt es als Lese- und als Bearbeitungsstufe.

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, Bearbeitungsschlüssel auf e. Projektschlüssel rufen /api/skimle-read und /api/skimle-write auf. Kontoschlüssel rufen /api/skimle-account auf.

Die API-Referenz öffnen

Sehen Sie sich jeden Endpunkt mit Beschreibung, Aufbau der Anfrage und einem Testbereich an. Jede Route nimmt einen Body als Discriminated Union, unterschieden über das Feld action.

Referenz öffnen Endpunkte zum Lesen →Endpunkte zum Schreiben →Projekt-Endpunkte →

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