API

ArchibotChat-API-Schlüssel

Erstellen, kopieren, rotieren und widerrufen Sie generierte API-Schlüssel und verbinden Sie ein externes Mitarbeiter-Tool mit dem öffentlichen Archibot-Endpunkt.

KundenadministratorenKundenmitgliederPlattformbetreiber

Zuletzt aktualisiert 18. Juni 2026

Die Registerkarte API-Schlüssel in den Einstellungen: Generierte Schlüssel werden hier erstellt, der Rohwert wird nur einmal angezeigt und ein kopierbares Einrichtungsskript verbindet ein externes Mitarbeiter-Tool mit dem Endpunkt.

Mit API-Schlüsseln können Sie den öffentlichen Archibot-Endpunkt aus Skripten, lokalen Agent-Tools und Integrationen aufrufen, die außerhalb eines verwalteten Workspace laufen. Sie sind getrennt von der verborgenen Anmeldeinformation, die den Chat-Bildschirm im Browser antreibt und die Benutzern niemals angezeigt wird.

Verwaltete Archibot-Workspaces stellen ihre eigenen Schlüssel bereits automatisch bereit. Verwenden Sie einen generierten API-Schlüssel nur für ein lokales Agent-Tool, eine Editor-Erweiterung oder ein kundeneigenes Harness, das Archibot als externen Mitarbeiter aufrufen soll.

Wann API-Schlüssel zu verwenden sind

Erstellen Sie einen generierten Schlüssel, wenn Sie Folgendes benötigen:

Archibot aus einem Skript oder einem geplanten Job aufrufen.
Ein lokales Agent-Tool oder eine Editor-Erweiterung mit dem Endpunkt verbinden.
Einen OpenAI-kompatiblen Client gegen den Archibot-Endpunkt ausführen.
Ein kundeneigenes Harness außerhalb des Workspace mit Archibot verbinden.

Für interaktive Fragen verwenden Sie stattdessen den Chat-Bildschirm im Browser. Siehe ArchibotChat verwenden.

Die Registerkarte API-Schlüssel öffnen

Öffnen Sie Einstellungen über die linke Navigation.
Wählen Sie die Ansicht Archibot account.
Öffnen Sie die Registerkarte API Keys.

Die Registerkarte befindet sich in derselben Reihe wie Setup, Git access, CI & Review, Support, Activity und Billing. Wenn der API-Zugriff für das Konto nicht aktiviert ist, zeigt die Registerkarte die Meldung API access is not enabled for this account. an und die Schaltfläche Create key ist deaktiviert. Bitten Sie zuerst einen Kundenadministrator oder ISM, das API-Produkt-Gate zu aktivieren. Siehe ArchibotChat-Einrichtung.

Registerkarte API-Schlüssel in den Console-Einstellungen mit der Schaltfläche Schlüssel erstellen, der Karte für externen Mitarbeiterzugriff und einem generierten Einrichtungsskript mit Platzhalterwerten für Endpunkt und Schlüssel.

Einen Schlüssel erstellen

Wählen Sie auf der Registerkarte API Keys die Option Create key.
Der neue Schlüssel erscheint oben in der Liste, und sein vollständiger Wert wird nur einmal in einem hervorgehobenen Hinweis angezeigt, der lautet Copy this key now. It will not be shown again.
Wählen Sie Copy neben dem Schlüsselwert.
Speichern Sie ihn in Ihrem genehmigten Secret Manager oder Ihrer Laufzeitumgebung.

Registerkarte API-Schlüssel direkt nach dem Erstellen eines Schlüssels, mit dem Einmal-Schlüssel-Hinweis, der besagt, dass der Schlüssel nicht erneut angezeigt wird, mit einer Schaltfläche Kopieren.

Schlüssel werden automatisch benannt (zum Beispiel Console generated key 1) und erhalten den Geltungsbereich api. Der Rohwert wird nur in diesem Hinweis angezeigt. Sobald Sie die Registerkarte verlassen oder einen weiteren Schlüssel erstellen, bleiben nur das Schlüsselpräfix und die Metadaten sichtbar.

Wenn die Schaltfläche zum Kopieren Ihre Zwischenablage nicht erreichen kann, zeigt die Registerkarte Clipboard copy unavailable an. Markieren Sie den Schlüsseltext manuell und kopieren Sie ihn, bevor Sie weiternavigieren.

Ein externes Mitarbeiter-Tool verbinden

Die Karte External coworker access erstellt ein einsatzbereites Einrichtungsskript, sodass Sie die Umgebungsvariablen nicht von Hand zusammenstellen müssen.

Die Karte zeigt zwei Referenzfelder:

Feld	Was es anzeigt
Public endpoint	Die Basis-URL, die Ihre Integration aufrufen sollte, zum Beispiel `https://chat.archibot.cloud/v1`.
Key source	`New one-time key included` direkt nach dem Erstellen oder Rotieren eines Schlüssels, andernfalls `Generate or rotate a key`.

Unter diesen Feldern zeigt eine Vorschau ein Shell-Skript, das die Umgebungsvariablen für Endpunkt und Schlüssel exportiert und einen Beispiel-Mitarbeiterbefehl ausführt. Wenn Sie gerade einen Schlüssel erstellt oder rotiert haben, enthält das Skript diesen Einmal-Schlüsselwert; andernfalls verwendet es einen Platzhalter <new-api-key>.

Erstellen oder rotieren Sie einen Schlüssel, sodass das Feld Key source New one-time key included anzeigt.
Wählen Sie Copy setup auf der Karte External coworker access.
Fügen Sie das Skript in Ihre lokale Shell, Ihren Secret Manager oder Ihre Tool-Konfiguration ein.

Das Skript setzt standardmäßige OpenAI-kompatible Variablen (OPENAI_BASE_URL, OPENAI_API_KEY) zusammen mit Archibot-Mitarbeitervariablen, sodass sowohl OpenAI-kompatible Clients als auch das Archibot-Mitarbeiter-Tooling denselben Endpunkt und Schlüssel übernehmen. Verwenden Sie die von ISM für Ihr Konto bereitgestellte Produktions-Endpunkt-URL, anstatt sie aus einem lokalen Beispiel abzuleiten.

Einen Schlüssel verwenden

Verwenden Sie den Schlüssel als Bearer-Token gegen den OpenAI-kompatiblen Archibot-Endpunkt.

curl https://chat.example.archibot.cloud/v1/responses \
  -H "Authorization: Bearer $ARCHIBOT_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
    "model": "archibot",
    "input": "Summarize this Archibus request queue export."
  }'

Der Endpunkt leitet OpenAI-kompatible Felder der Responses-API wie tools, tool_choice, reasoning, metadata und strukturierte input-Inhalte an den Archibot-Endpunkt weiter, nachdem die API-Schlüssel- und Guthabenprüfungen bestanden wurden.

Für gestreamte Antworten senden Sie stream: true:

curl -N https://chat.example.archibot.cloud/v1/responses \
  -H "Authorization: Bearer $ARCHIBOT_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
    "model": "archibot",
    "input": "Draft a short work plan for this Archibus data cleanup.",
    "stream": true
  }'

Gestreamte Antworten geben Abrechnungsnachweise in X-Archibot-*-Antwort-Headern zurück, anstatt jedes Ereignis-Chunk neu zu schreiben.

Die OpenAI-kompatible Modellerkennung verwendet denselben Bearer-Schlüssel:

curl https://chat.example.archibot.cloud/v1/models \
  -H "Authorization: Bearer $ARCHIBOT_API_KEY"

Die Modellerkennung zieht nicht von Ihrem Nutzungskontingent ab.

Ratenlimits

Generierte API-Schlüssel haben ein Anfragelimit pro Schlüssel. Antworten enthalten die Header X-RateLimit-Limit, X-RateLimit-Remaining und X-RateLimit-Reset. Wenn das Limit überschritten wird, gibt der Endpunkt 429 mit einem Retry-After-Header zurück.

Ablauf

Generierte API-Schlüssel laufen ein Jahr nach der Erstellung ab. Jede Schlüsselzeile zeigt ihr Erstellungs-, Ablauf- und Zuletzt-verwendet-Datum neben dem Schlüsselpräfix an.

Abgelaufene Schlüssel bleiben nach Name, Präfix und Metadaten sichtbar, sodass Sie alte Integrationen prüfen können, aber sie können die Modellerkennung oder den Responses-Endpunkt nicht mehr aufrufen. Ablehnungen abgelaufener Schlüssel erfolgen, bevor irgendeine Nutzung gezählt wird. Rotieren Sie einen abgelaufenen Schlüssel, um einen Ersatz unter demselben Namen und Geltungsbereich auszustellen, oder widerrufen Sie ihn, wenn die Integration eingestellt wird.

Einen Schlüssel rotieren

Rotieren Sie einen Schlüssel, wenn eine Integration unter demselben Namen und Geltungsbereich weiterlaufen soll, aber der geheime Wert geändert werden muss.

Finden Sie auf der Registerkarte API Keys den aktiven Schlüssel nach Name oder Präfix.
Wählen Sie Rotate in dieser Schlüsselzeile.
Kopieren Sie den Ersatzwert aus dem Einmal-Hinweis.
Aktualisieren Sie das betroffene Skript, den Secret-Manager-Eintrag oder die Laufzeitumgebung.

Die Rotation widerruft den vorherigen Schlüssel und erstellt einen Ersatz mit demselben Namen und Geltungsbereich. Der Ersatzwert wird nur einmal angezeigt, im selben Hinweis, der für neue Schlüssel verwendet wird. Die Rotation wirkt sofort; es gibt keinen separaten Bestätigungsdialog, seien Sie also bereit, die Integration zu aktualisieren, bevor der alte Datenverkehr fehlschlägt.

Einen Schlüssel widerrufen

Widerrufen Sie einen Schlüssel, wenn:

Er nicht mehr verwendet wird.
Er in einen Chat, eine E-Mail, ein Ticket, ein Repository oder ein freigegebenes Dokument eingefügt wurde.
Der Inhaber das Team verlässt.
Die Integration ersetzt wird.

Finden Sie auf der Registerkarte API Keys den Schlüssel nach Name oder Präfix.
Wählen Sie Revoke in dieser Schlüsselzeile.
Aktualisieren oder entfernen Sie jedes Skript oder jede Integration, die darauf angewiesen war.

Der Widerruf wird sofort wirksam und es gibt keinen separaten Bestätigungsdialog, bestätigen Sie also, dass es der richtige Schlüssel ist, bevor Sie Revoke wählen.

Abrechnung

Generierte API-Schlüssel ziehen vom selben gemeinsamen Chat- und API-Nutzungskontingent ab, das in Billing angezeigt wird. Fehlgeschlagene Vorabprüfungen und abgelehnte Upstream-Anfragen sollten keine Guthaben verbrauchen; eine gestreamte Anfrage wird abrechenbar, sobald der Archibot-Endpunkt den Stream akzeptiert. Siehe ArchibotChat-Abrechnung und Guthaben.

Sicherheitsregeln

Committen Sie API-Schlüssel niemals in die Versionskontrolle.
Fügen Sie API-Schlüssel niemals in Support-Tickets oder freigegebene Dokumente ein.
Verwenden Sie Umgebungsvariablen oder einen Secret Manager, keine Inline-Werte.
Verwenden Sie nach Möglichkeit einen Schlüssel pro Integration.
Rotieren Sie Schlüssel regelmäßig für langlebige Integrationen.
Widerrufen Sie einen Schlüssel sofort, wenn eine Offenlegung vermutet wird.

Chat-Anmeldeinformation versus API-Schlüssel

Anmeldeinformation	Für Benutzer sichtbar	Verwendet für
Verborgene Chat-Anmeldeinformation	Nein	Chat-Bildschirm im Browser
Generierter API-Schlüssel	Ja, einmal	Skripte, lokale Agent-Tools und Endpunkt-Integrationen

Bitten Sie den ISM-Support nicht, die verborgene Chat-Anmeldeinformation offenzulegen. Sie ist absichtlich nicht für Benutzer sichtbar.

Fertig, wenn

Der API-Zugriff ist für das Konto aktiviert.
Der generierte Schlüsselwert wird kopiert und gespeichert, bevor Sie die Registerkarte verlassen.
Integrationen verweisen auf die für das Konto bereitgestellte ArchibotChat-Endpunkt-URL.