Authentifizierung
Authentifizieren Sie API-Anfragen mit Bearer-Token und Ihrem API-Schlüssel.
Alle API-Anfragen erfordern eine Authentifizierung per Bearer-Token. Generieren Sie einen API-Schlüssel in Ihrem Dashboard und fügen Sie ihn in den Authorization-Header ein.
Hinweis: Für den API-Zugriff ist mindestens ein Hobby-Tarif mit aktiver Abrechnung erforderlich.
Einen API-Schlüssel generieren
- Rufen Sie das Dashboard Ihres Team-Workspace auf
- Klicken Sie in der Seitenleiste auf API-Schlüssel
- Klicken Sie auf API-Schlüssel erstellen
- Kopieren Sie den generierten Schlüssel
Verwendung Ihres API-Schlüssels
Fügen Sie den Schlüssel in den Authorization-Header 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"}]}'
Header-Format
Authorization: Bearer YOUR_API_KEY
Ihren Schlüssel testen
Überprüfen Sie mit dem Auth-Endpunkt, ob Ihr API-Schlüssel funktioniert:
curl 'https://your-domain.com/api/v1/auth' \ -H 'Authorization: Bearer YOUR_API_KEY'
Erfolgreiche Antwort (200):
{
"id": "account-uuid",
"name": "Your Workspace",
"email": "[email protected]"
}
Ungültiger Schlüssel (401):
{
"message": "Missing or invalid Authorization header"
}
Sicherheit der API-Schlüssel
Best Practices
- Schlüssel niemals im clientseitigen Code offenlegen - API-Schlüssel dürfen nur serverseitig verwendet werden
- Umgebungsvariablen verwenden - Schlüssel nicht im Code hartcodieren
- Schlüssel regelmäßig rotieren - Alte Schlüssel löschen und neue erstellen
- Aussagekräftige Namen verwenden - Behalten Sie den Überblick, welcher Schlüssel wo verwendet wird
Schlüsselformat
Schlüssel bestehen aus 32 zufälligen Bytes, base64url-codiert.
API-Schlüssel verwalten
Alle Schlüssel anzeigen
Alle Schlüssel finden Sie unter Workspace > API-Schlüssel.
Schlüssel löschen
Entfernen Sie Schlüssel, die Sie nicht mehr benötigen:
- Rufen Sie API-Schlüssel auf
- Suchen Sie den Schlüssel
- Klicken Sie auf Löschen
- Bestätigen Sie den Löschvorgang
Gelöschte Schlüssel funktionieren sofort nicht mehr.
Fehlerantworten
| Status | Nachricht | Ursache |
|---|---|---|
| 401 | Missing or invalid Authorization header | Header wurde nicht angegeben |
| 401 | Invalid API key | Schlüssel ist falsch |
| 403 | API access requires a Hobby plan or above with active billing | Tarif oder Abrechnungsstatus erlaubt keinen API-Zugriff |
| 403 | Chatbot does not belong to this account | Agent-ID gehört nicht zum Konto des API-Schlüssels |
Einrichtung der Umgebung
Node.js
const API_KEY = process.env.AGENTKIT_API_KEY;
const response = await fetch('https://your-domain.com/api/v1/chat', {
method: 'POST',
headers: {
'Authorization': `Bearer ${API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
chatbotId: 'your-chatbot-id',
messages: [{ role: 'user', content: 'Hello' }],
}),
});
Python
import os
import requests
API_KEY = os.environ.get('AGENTKIT_API_KEY')
response = requests.post(
'https://your-domain.com/api/v1/chat',
headers={
'Authorization': f'Bearer {API_KEY}',
'Content-Type': 'application/json',
},
json={
'chatbotId': 'your-chatbot-id',
'messages': [{'role': 'user', 'content': 'Hello'}],
},
)
cURL
export AGENTKIT_API_KEY="your-api-key"
curl -X POST 'https://your-domain.com/api/v1/chat' \
-H "Authorization: Bearer $AGENTKIT_API_KEY" \
-H 'Content-Type: application/json' \
-d '{"chatbotId": "uuid", "messages": [{"role": "user", "content": "Hello"}]}'