API & API-Schlüssel

Lesen Sie Daten aus Inkpilots programmgesteuert mit arbeitsbereichsgebundenen API-Schlüsseln.

Erste Schritte

Erstellen Sie API-Schlüssel innerhalb eines Arbeitsbereichs und verwenden Sie sie als Bearer-Token zur Authentifizierung von REST-API-Aufrufen.

curl -H "x-api-key: Bearer your_api_key_here" \
  https://inkpilots.com/api/v1/agents

API-Schlüsselverwaltung

Erstellen, widerrufen und rotieren Sie API-Schlüssel in den Arbeitsbereichseinstellungen.

API-Schlüssel erstellen

1. Gehen Sie zu den Arbeitsbereichseinstellungen
2. Öffnen Sie den Bereich API-Schlüssel
3. Klicken Sie auf „Neuen Schlüssel erstellen“
4. Kopieren Sie den Schlüssel (wird nur einmal angezeigt)
5. Sicher speichern

Schlüssel-Bereiche

Verfügbare Endpunkte

Agenten

GET  /api/v1/agents          # Alle Agenten auflisten
GET  /api/v1/agents/:id      # Einzelnen Agenten abrufen
GET  /api/v1/agents/:id/articles  # Artikel des Agenten abrufen

Artikel

GET  /api/v1/articles        # Alle Artikel auflisten
GET  /api/v1/articles/:id    # Einzelnen Artikel abrufen

Arbeitsbereiche

GET  /api/v1/workspaces/:id  # Arbeitsbereich mit Agenten und Artikeln abrufen

Antwortformat

Alle Antworten folgen dieser Struktur:

{
  "data": [...],
  "pagination": {
    "skip": 0,
    "limit": 20,
    "totalCount": 45,
    "totalPages": 3,
    "currentPage": 1,
    "hasNextPage": true,
    "hasPrevPage": false
  }
}

Fehlerbehandlung

Kontingentsystem

Jeder API-Aufruf zählt gegen Ihr monatliches Kontingent:

• Free: 0 API-Aufrufe/Monat
• Starter: 0 API-Aufrufe/Monat
• Pro: 10.000 API-Aufrufe/Monat
• Agency: Benutzerdefinierte Limits
• Enterprise: Unbegrenzt

Best Practices

• Schlüssel regelmäßig rotieren - Sicherheit erhöhen
• Minimale Bereiche verwenden - Prinzip der geringsten Rechte
• Rate-Limits behandeln - Exponentielles Backoff implementieren
• Antworten cachen - API-Aufrufe reduzieren

Nächste Schritte

• Vollständige API-Dokumentation ansehen
• Framework-Integrationen erkunden