API-Schlüssel
Erstellen und verwalten Sie API-Schlüssel für den programmatischen Zugriff.
Mit API-Schlüsseln erhalten Sie programmatischen Zugriff auf Ihre Agenten. Nutzen Sie sie, um Agentkit in Ihre Anwendungen zu integrieren oder mit Drittanbieterdiensten zu verbinden.
Zum Erstellen von Schlüsseln und zur Nutzung der API benötigen Sie einen Hobby-Plan oder höher mit aktiver Abrechnung. Workspace-Mitglieder können vorhandene Schlüssel auch nach Verlust dieser Berechtigung weiterhin anzeigen und widerrufen. Tarif upgraden →
Einen API-Schlüssel erstellen
- Öffnen Sie Ihren Workspace
- Klicken Sie in der Seitenleiste auf API-Schlüssel
- Klicken Sie auf API-Schlüssel erstellen
- Bestätigen Sie im Dialogfeld
Der neue Schlüssel erscheint in der Liste und kann jederzeit angezeigt oder kopiert werden.
Schlüssel anzeigen und kopieren
Jeder Schlüssel in der Liste ist standardmäßig maskiert. Nutzen Sie das Augensymbol, um einen Schlüssel anzuzeigen, und das Kopiersymbol, um ihn in Ihre Zwischenablage zu kopieren.
API-Schlüssel verwenden
Fügen Sie den Schlüssel in API-Anfragen ein:
curl -X POST 'https://your-domain.com/api/v1/chat' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"chatbotId": "uuid", "messages": [{"role": "user", "content": "Hello"}]}'
Vollständige API-Dokumentation →
Schlüssel verwalten
Alle Schlüssel anzeigen
Alle Schlüssel des Workspace sind auf der Seite API-Schlüssel aufgelistet.
Einen Schlüssel löschen
- Suchen Sie den Schlüssel in der Liste
- Klicken Sie auf das Papierkorb-Symbol
- Bestätigen Sie die Löschung
Gelöschte Schlüssel funktionieren sofort nicht mehr.
Schlüssel nach Ablauf des Zugriffs widerrufen
Wenn Ihr Workspace den API-Zugriff verliert, melden Sie sich an und löschen Sie nicht mehr benötigte Schlüssel auf der Seite API-Schlüssel. Dafür müssen Sie die Abrechnung nicht erneuern. Sie müssen weiterhin Mitglied des Workspaces sein. Wenn Sie MFA aktiviert haben, schließen Sie die MFA-Prüfung ab, bevor Sie Schlüssel verwalten. Bis dahin verbirgt die Datenbank die Schlüssel des Workspaces und verweigert das Löschen. Dadurch erhalten Sie weder API-Zugriff noch die Berechtigung zum Erstellen von Schlüsseln zurück.
Agentkit prüfte früher die kostenpflichtige API-Berechtigung, bevor es einen Schlüssel löschte. Auch die Datenbankrichtlinien verlangten diese Berechtigung zum Lesen oder Löschen. Der Verlust des Zugriffs konnte deshalb die Bereinigung vorhandener Zugangsdaten blockieren.
Die Korrektur trennt das Erstellen von der Bereinigung. Die Workspace-Mitgliedschaft bestimmt den Lese- und Löschzugriff; eine separate Datenbankrichtlinie erzwingt MFA. Zum Erstellen und Aktualisieren von Schlüsseln ist weiterhin eine API-Berechtigung erforderlich. Die Löschaktion gleicht sowohl die Schlüssel-ID als auch die Workspace-ID ab und meldet nur Erfolg, wenn die Datenbank eine gelöschte Zeile zurückgibt.
Dieses vereinfachte Beispiel beschreibt die Änderung der Prüfung:
Before Require API entitlement before deleting an existing key. After Delete only a key belonging to the requested workspace. Require a returned deleted row before reporting success. Keep membership checks and enforce MFA in the database.
Die Anwendungstests simulieren den Datenbankclient. Sie prüfen Filter und Ergebnisbehandlung, nicht die Datenbankrichtlinien. Die SQL-Tests verwenden synthetische Konten und rollen Änderungen zurück. Zu ihren erwarteten Ergebnissen gehören:
| Prüfung | Testebene | Erwartetes Ergebnis |
|---|---|---|
| Berechtigtes Mitglied widerruft ohne API-Berechtigung | Anwendungssimulation | Keine Berechtigungsabfrage; Schlüssel- und Workspace-Filter; Erfolg erfordert eine zurückgegebene Zeile |
| Berechtigtes Mitglied widerruft ohne API-Berechtigung | SQL | Ein Schlüssel des eigenen Workspaces gelöscht |
| Mitglied erstellt einen Schlüssel ohne Berechtigung | Anwendungssimulation und SQL | Abgelehnt |
| Mitglied versucht, einen Schlüssel eines anderen Workspaces zu löschen | SQL | Keine Zeile gelöscht |
| Erforderliche MFA ist nicht erfüllt | SQL | Keine Zeile gelöscht |
| Angeforderter Schlüssel fehlt oder ist für den Aufrufer unsichtbar | Anwendungssimulation | Aktion meldet Fehler |
Dies sind Regressionserwartungen, keine Ergebnisse eines Produktionstests. Verwenden Sie dasselbe Testmuster für temporäre Zugangsdaten in Agenten-Workflows. Ändern Sie den Zugriff vor der Bereinigung und prüfen Sie dann sowohl die erfolgreiche berechtigte als auch die abgelehnte unberechtigte Bereinigung.
Best Practices für die Sicherheit
Schlüssel niemals offenlegen
- Committen Sie keine Schlüssel in Git-Repositorys
- Fügen Sie keine Schlüssel in clientseitigen Code ein
- Verwenden Sie Umgebungsvariablen
Schlüssel regelmäßig rotieren
- Erstellen Sie regelmäßig neue Schlüssel
- Aktualisieren Sie Ihre Anwendungen
- Löschen Sie alte Schlüssel
Separate Schlüssel verwenden
Erstellen Sie unterschiedliche Schlüssel für:
- Produktion vs. Entwicklung
- Unterschiedliche Anwendungen
- Unterschiedliche Teammitglieder oder Dienste
Schlüsselumfang
API-Schlüssel sind an den Workspace gebunden, in dem sie erstellt wurden, und haben Zugriff auf:
- Alle Agenten im Workspace
- Chat-API-Endpunkte
- Webhook-Verwaltung
Schlüssel können nicht:
- Teammitglieder verwalten
- Auf die Abrechnung zugreifen
- Weitere API-Schlüssel erstellen
Zapier-Verbindung
Beim Verbinden mit Zapier:
- Erstellen Sie einen dedizierten API-Schlüssel für Zapier
- Verwenden Sie diesen Schlüssel in der Zapier-Verbindung
- Halten Sie den Schlüssel von anderen Verwendungen getrennt
Fehlerbehebung
Fehler „Invalid API key“
- Prüfen Sie, ob der Schlüssel korrekt kopiert wurde
- Achten Sie auf führende/nachgestellte Leerzeichen
- Bestätigen Sie, dass der Schlüssel nicht gelöscht wurde
Fehler „Key not authorized“
- Stellen Sie sicher, dass der Agent zu Ihrem Workspace gehört
- Prüfen Sie, ob der Workspace des Schlüssels übereinstimmt
- Bestätigen Sie für API-Anfragen, dass Ihr Workspace auf Hobby oder höher mit aktiver Abrechnung ist
Schlüssel funktioniert nach dem Erstellen nicht
- Aktualisieren Sie die Seite
- Warten Sie 30 Sekunden, bis die Änderung wirksam wird
- Erstellen Sie einen neuen Schlüssel, falls das Problem weiterhin besteht