Erste Schritte

Stelle in wenigen Minuten deine erste Anfrage an die aclipp API.

Als Markdown ansehen

Mit der aclipp API kannst du den Workspace programmatisch auslesen und verwalten: Clippings abrufen, Reports erzeugen und die Arbeit automatisieren, die du sonst im Dashboard machst. Alles ist auf einen einzigen Workspace beschränkt, der durch deinen Bearer-Zugangsnachweis impliziert wird. Dieser Guide verwendet einen manuell erstellten API-Key. Registrierte OAuth-Clients können für MCP-Verbindungen stattdessen ein Access-Token verwenden; die Public API akzeptiert API-Keys.

1. API-Key erstellen

Öffne die Workspace-Einstellungen und erstelle einen Key. Keys können nur Workspace-Admins erstellen; siehst du die Option nicht, frag eine:n Admin. Den vollständigen Key siehst du genau einmal, kopiere ihn dir also an einen sicheren Ort. Gib ihm nur die Scopes, die er wirklich braucht (siehe Authentifizierung & Scopes).

2. Anfrage stellen

Sende den Key als Bearer-Token im Authorization-Header. Die Basis-URL ist https://api.aclipp.com/api/v1.

Bash
curl "https://api.aclipp.com/api/v1/me" \
  -H "Authorization: Bearer aclipp_live_..."

GET /me gibt den Workspace, die Scopes und die Projekt-Einschränkung zurück, auf die der Zugangsnachweis aufgelöst wird. Das ist der schnellste Weg, um die Authentifizierung zu prüfen.

3. Erkunden

Jeder Endpunkt, seine Parameter sowie Beispielanfragen und -antworten stehen in der API-Referenz. Ein paar Dinge, die du wissen solltest:

  • Antworten sind JSON. Fehler nutzen das Format { "error": { "code", "message" } }.
  • Große Listen sind paginiert über die Parameter page und limit, wenn der Endpunkt Pagination unterstützt.
  • Anfragen sind pro Workspace rate-limitiert; bei Überschreitung bekommst du einen 429 mit einem Retry-After-Header.

Wenn du bereit bist, lies Authentifizierung & Scopes, um zu verstehen, was die verschiedenen Zugangsnachweise dürfen und was nicht, und Rate Limits, um Retries und Hintergrundjobs zu planen.

API-Referenz durchsuchen

Finde einen Endpunkt nach Name, Methode oder Pfad.