Zum Hauptinhalt springen
Wenn Sie einen API-Key über die Konsole oder die REST-API erstellen oder lesen, gibt das Gateway ein Token-Objekt zurück — den JSON-Datensatz, der die Identität eines Schlüssels, seine Limits und die beiden Policy-Bindungen hält, die seinen Traffic steuern. Diese Seite ist die Feld-für-Feld-Referenz für dieses Objekt: was jedes Feld bedeutet, sein Typ und die Sentinel-Werte (0, -1), die eine besondere Bedeutung tragen. Für das Warum hinter diesen Feldern — das Least-Agency-Modell — starten Sie bei der Übersicht über Scoped Keys. Diese Seite ist die Nachschlagetabelle, die Sie offen halten, während Sie die Schlüsselerstellung skripten.

​
1. Die Token-Objekt-Referenz auf einen Blick

Ein frisch erstellter Schlüssel für einen geplanten Summarizer-Agenten sieht so aus: 
{
  "id": 4812,
  "name": "support-summarizer-prod",
  "status": 1,
  "key": "sk-orca-a1b2****yz90",
  "created_time": 1733616000,
  "accessed_time": 1733702400,
  "expired_time": -1,
  "unlimited_quota": false,
  "remain_quota": 500000,
  "used_quota": 12340,
  "model_limits_enabled": true,
  "model_limits": "openai/gpt-4o-mini",
  "credit_limit_usd": 25,
  "allow_ips": "203.0.113.7",
  "environment": "prod",
  "guardrail_id": 17,
  "firewall_policy_id": 9,
  "is_firewall_gateway": false,
  "group": "default"
}
Das key-Feld ist bei jedem Lesen maskiert — Sie sehen das Marken-Präfix und die letzten vier Zeichen, nie das vollständige Secret. Der Klartext wird einmal gezeigt, bei der Erstellung. Siehe Schlüsselmaskierung.

​
2. Identitäts- & Lebenszyklus-Felder

Diese beschreiben, welcher Schlüssel das ist und wo er in seinem Lebenszyklus ist.
Der stabile numerische Identifikator des Schlüssels. Verwenden Sie ihn, um den Schlüssel in Update- und Delete-Aufrufen anzusprechen. Schreibgeschützt.
Ein menschliches Label für den Schlüssel, in der Konsole und in Logs gezeigt. Benennen Sie Schlüssel nach dem Agenten, der sie hält — ein Schlüssel, ein Agent.
Aktiviert / deaktiviert-Zustand. 1 bedeutet aktiv; ein deaktivierter Schlüssel wird bei Auth abgelehnt, ohne gelöscht zu werden, sodass Sie einen Schlüssel pausieren und wieder aktivieren können.
Das Bearer-Secret, maskiert zurückgegeben (sk-orca-…****…). Der vollständige Wert wird nur einmal gezeigt, bei der Erstellung. Behandeln Sie es wie ein Passwort.
Unix-Zeitstempel (Sekunden) dafür, wann der Schlüssel geprägt wurde und wann er zuletzt einen Request bedient hat. accessed_time ist Ihr Signal für einen abgestandenen oder ungenutzten Schlüssel, der einen Widerruf wert ist.
Absoluter Ablauf als Unix-Zeitstempel. Der Sentinel -1 bedeutet, der Schlüssel läuft nie ab. Setzen Sie einen echten Zeitstempel, um einen Schlüssel automatisch ablaufen zu lassen — der richtige Default für CI-Läufe und ephemere Agenten. Siehe Ablaufende Schlüssel.

​
3. Ausgaben- & Kontingent-Felder

Diese begrenzen, wie viel ein Schlüssel verbrauchen kann, bevor er aufhört zu funktionieren.
FeldTypBedeutung
credit_limit_usdnumberLebenszeit-Ausgabenlimit in USD. 0 = unbegrenzt.
unlimited_quotabooleanWenn true, wird der Schlüssel nicht gegen einen Kontingent-Saldo abgerechnet.
remain_quotanumberVerbleibendes Kontingent auf dem Schlüssel.
used_quotanumberBisher verbrauchtes Kontingent.
Ein Schlüssel mit credit_limit_usd: 0 und unlimited_quota: true und expired_time: -1 hat keine Ausgaben-Obergrenze und läuft nie ab — der schlimmste Blast-Radius, wenn er leakt. Siehe unbegrenzt vs. begrenzt dafür, wann ein unbegrenzter Schlüssel gerechtfertigt ist.

​
4. Reichweite- & Scope-Felder

Diese begrenzen, was der Schlüssel erreichen kann — welche Modelle, von welchen Adressen.
model_limits ist die Liste der Modelle, die der Schlüssel aufrufen darf; model_limits_enabled ist der Ein-/Aus-Schalter. Mit aktiviertem Limit wird ein Aufruf an irgendein Modell außerhalb der Liste abgelehnt, bevor er das Gateway verlässt — der Agent kann nicht zu einem teureren oder fähigeren Modell wechseln. Siehe Modell-Limits.
Eine IP- / CIDR-Allowlist, ein Eintrag pro Zeile. Ein Request, der den Schlüssel von irgendeiner ungelisteten Adresse präsentiert, wird auf der Auth-Ebene abgelehnt; ein leerer Wert bedeutet, dass alle Adressen erlaubt sind. Siehe IP-Allowlist.
Ein freiform Deployment-Label (prod, staging, dev oder was immer Sie wählen) zum Organisieren von Schlüsseln und Filtern von Logs. Rein organisatorisch — es ändert nicht die Durchsetzung. Siehe Umgebungen.
Die Routing-Gruppe, durch die der Schlüssel Modelle auflöst. Lassen Sie sie auf dem Workspace-Default, es sei denn, Ihnen wurde eine bestimmte Gruppe gegeben.

​
5. Policy-Bindungs-Felder

Die beiden mächtigsten Felder auf einem Schlüssel. Jedes bindet den Schlüssel an eine workspace-bezogene Policy, die seinen Traffic steuert — ändern Sie die Policy, und jeder daran angehängte Schlüssel übernimmt die Änderung beim nächsten Request, kein Redeploy.
FeldTypBindet den Schlüssel an
guardrail_idnumberEin Content-Guardrail, das Request- und Antwort-Text prüft.
firewall_policy_idnumberEine Firewall-Policy, die die Tool-Calls steuert, die der Schlüssel ausgibt.
is_firewall_gatewaybooleanMarkiert den Schlüssel als gateway-scoped Token für die Firewall-MCP- / Evaluate-Routen (nicht für Inferenz).
Der Sentinel für beide Bindungen ist 0 (ungebunden). Aber die beiden Ebenen lösen eine deaktivierte Bindung unterschiedlich auf:
  • Eine deaktivierte guardrail_id ist der Aus-Schalter — der Schlüssel bekommt kein Guardrail, ohne Fallback auf den Workspace-Default.
  • Eine deaktivierte firewall_policy_id fällt auf die Default-Firewall-Policy des Workspaces zurück.
Die vollständige Auflösungsreihenfolge lebt auf Policies binden und Scope & Schlüssel.
is_firewall_gateway: true prägt einen gateway-scoped Schlüssel nur für die /api/v1/firewall/*-Routen — setzen Sie ihn nie auf einen Inferenz-Schlüssel. Das Flag zu aktivieren und den Klartext eines Gateway-Schlüssels zu lesen, erfordern beide Admin+.

​
6. Diese Felder setzen

Jedes Feld oben wird im Konsolen-Schlüssel-Editor (/console/token) konfiguriert — nicht über einen Relay-Schlüssel. Das Erstellen oder Bearbeiten eines Schlüssels erfordert die Rolle Developer oder höher; das is_firewall_gateway-Flag erfordert Admin+.
Das Token-Objekt ist die Konfigurations-Oberfläche. Der Klartext (sk-orca-…) des Schlüssels ist das, was Ihr Agent auf den /v1/*-Relay-Aufrufen präsentiert. Konfigurieren Sie den Schlüssel in der Konsole; der Agent sieht nur jemals das Secret.
Ein konkreter Least-Agency-Schlüssel — im Editor gesetzt, als das Objekt oben zurückgelesen — deckelt ein Modell, einen Quell-IP-Bereich, eine wöchentliche USD-Obergrenze, einen Ablauf und ein Guardrail plus eine Firewall-Policy. Wenn der Agent, der ihn hält, via Prompt-Injection gekapert wird, stoppt der Blast-Radius an genau diesen Grenzen.

​
7. Verwandte Referenzen

Übersicht über Scoped Keys

Das Least-Agency-Modell und der Hub für jedes Schlüsselfeld.

Policies binden

Wie guardrail_id und firewall_policy_id auf eine aktive Policy auflösen.

Kontingent, Cap & Ablauf

credit_limit_usd, expired_time und die Kontingent-Felder in der Tiefe.

Least-Agency-Checkliste

Schicken Sie jeden Schlüssel durch denselben Härtungs-Durchgang.
Neu beim Modell? Lesen Sie Scope, Schlüssel, Policies & Workspaces dafür, wie das Token-Objekt in die Workspace → Policy → Schlüssel-Hierarchie passt.