API-Key anlegen und Scopes wählen
Ein API-Key für die REST-API, eigene Agenten und Dienste, mit genau den Scopes, die du ihm gibst.
Zuletzt aktualisiert:
Ein API-Key gibt deinem System oder Agenten genau die Scopes, die du ihm gibst. Hier legst du ihn an. Wie sich ein Aufruf von /v1 mit dem Key anmeldet, steht unter Anmeldung.
Einen Key anlegen
- Einstellungen, API-Keys öffnen.
- Namen vergeben und Scopes wählen:
readist immer dabei,proposeundapprovenur, wenn der Agent sie braucht. Auf Wunsch schränkst du den Key je Ressource ein. - Den Key (
ath_live_...) kopieren. Er wird nur einmal angezeigt.
Bei Art des Keys wählst du Live oder Test. Ein Test-Key (ath_test_...) steht in derselben Liste, arbeitet aber im Testbüro mit erfundenen Daten, aus dem nichts hinausgeht, und gilt nur an der REST-API. Den Tarif des echten Büros fragt er wie jeder Key.
Schick ihn als Authorization: Bearer ath_live_... mit (Anmeldung). Ein Live-Key gilt überall: an der REST-API, am MCP-Server und für eigene Agenten. Ein Test-Key gilt nur an der REST-API.
Was du wissen musst
- Gespeichert wird nur ein Abdruck; wer den Key verliert, legt einen neuen an.
- Jedes Mitglied legt Keys an und widerruft seine eigenen. Die Leitung sieht und widerruft alle Keys des Büros. Widerrufen wirkt sofort.
- An der REST-API handelt der Key für das Büro. Am MCP-Server und für eigene Agenten handelt er als die Person, die ihn angelegt hat, mit deren Rolle und höchstens den Scopes des Keys.
- Verlässt ein Mitglied das Büro, enden seine Keys. Keys der Leitung bleiben beim Büro und handeln dann als Inhaber.
- Ein Key kann nie mehr als die Person, die ihn anlegt: Zugriff auf
contacts,webhookEndpointsundapiKeysan der REST-API gibt es nur mit einem Key der Leitung. - Ein Key, den du je Ressource einschränkst, gilt nur an der REST-API. Am MCP-Server und für eigene Agenten antwortet er mit
schluessel_nur_v1. - Keys gibt es in Pro und Scale; in Basic antwortet die API mit
plan_required. - Ein Key im Format
ath_...ohnelivegilt auch an der REST-API und steht in derselben Liste.
Welche Scopes
An der REST-API heißen die drei Scopes read, propose und approve (Scopes und Stufen). Am MCP-Server heißen dieselben drei lesen, vorschlagen und freigeben (Rechte).
| REST-API | MCP-Server | Bei der REST-API | Bei Athaus für Anbieter |
|---|---|---|---|
read | lesen | jeder lesende Aufruf | alle lesenden Werkzeuge |
propose | vorschlagen | schreibende Aufrufe; Nachrichten vorbereiten | Entwürfe, Vorschläge, Bewertungen |
approve | freigeben | eine Nachricht geht ohne Ja hinaus, wenn die Automatik des Büros es erlaubt | Vorschläge entscheiden; Automatisches läuft ohne Klick |
Gib nur, was der Agent braucht: Wer Antworten entwerfen soll, braucht propose ohne approve, dann wartet jeder Entwurf auf dein Ja.
Weiter lesen
REST-API: Anmeldung mit einem API-Key
Jeder Aufruf von /v1 trägt einen API-Key als Bearer-Token. Wo du ihn bekommst, welche Scopes er trägt und was nicht geht.
MCP-Rechte: was ein Agent darf
Je Server drei Rechte, unabhängig voneinander, und die Regel, wann ein Klick nötig ist. Im OAuth-Protokoll sind die Rechte die Scopes, unter demselben Namen.
Fehlercodes der API: was jeder Code bedeutet
Jeder Code, den die REST-API im Mitglied code eines Problems liefert, mit HTTP-Status und Bedeutung. Aus dem Vertrag erzeugt.