Anleitungen

Schnellstart

Erstellen und verwalten Sie Standard-API-Schlüssel und Sicherheitsleitlinien mit einem RunAPI-Verwaltungsschlüssel.

Die Plattformverwaltung ermöglicht es Kontoadministratoren, Standard-API-Schlüssel und Sicherheitsregeln zu erstellen, einzusehen, zu aktualisieren und zu widerrufen, ohne für jede Änderung das Dashboard zu verwenden.

Einen Management-Schlüssel erstellen

Folgen Sie dem Authentifizierungsleitfaden, um sich anzumelden, öffnen Sie dann die Seite für Verwaltungsschlüssel und erstellen Sie einen Verwaltungsschlüssel. Bewahren Sie ihn getrennt von Standard-Anwendungsschlüsseln auf. Senden Sie ihn als Bearer-Token nur an Platform-Management-Endpunkte.

HTTP

Authorization: Bearer YOUR_MANAGEMENT_KEY

Ein Standard-API-Schlüssel kann keine Schlüssel- oder Guardrail-Verwaltungsendpunkte aufrufen. Ein gültiger Verwaltungsschlüssel kann trotzdem 403 Forbidden erhalten, wenn dessen Inhaber nicht mehr über die erforderliche Kontorolle verfügt.

Standard-API-Schlüssel auflisten

Verwende GET /api/v1/keys, um die für das Verwaltungsschlüssel-Konto sichtbaren Schlüssel zu prüfen:

SHELL

curl "https://runapi.ai/api/v1/keys" \
  -H "Authorization: Bearer YOUR_MANAGEMENT_KEY"

Verwende zurückgegebene öffentliche Bezeichner für spätere Abruf-, Aktualisierungs-, Widerrufs- oder Guardrail-Zuweisungsanfragen. Leite niemals Zugriff aus einem Schlüsselnamen oder einem maskierten Token ab.

Schlüssel erstellen und rotieren

Erstellen Sie einen Anwendungsschlüssel mit POST /api/v1/keys. Das vollständige Secret wird nur in der Erstellungsantwort zurückgegeben; speichern Sie es daher in Ihrem Secret-Manager, bevor Sie diese Antwort verwerfen. Die Rotation sollte einen Ersatzschlüssel erstellen, ihn in der Anwendung bereitstellen, den Traffic überprüfen und dann den alten Schlüssel widerrufen.

SHELL

curl -X POST "https://runapi.ai/api/v1/keys" \
  -H "Authorization: Bearer YOUR_MANAGEMENT_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Production worker"}'

credit_limit_windows akzeptiert jede Kombination aus rollierenden Ausgabenlimits für 1h, 1d und 7d. Wenn ein konfiguriertes Fenster erschöpft ist, geben Aufrufe mit diesem Schlüssel 429 Too Many Requests zurück, bis der Verbrauch das Fenster verlässt. Senden Sie beim Aktualisieren eines Schlüssels ein leeres Objekt, um alle rollierenden Limits zu löschen.

Guardrails anwenden

Guardrails sind wiederverwendbare Kontorichtlinien für Modell-, Anbieter- und Ausgabenkontrollen. Verwalten Sie Richtlinien über /api/v1/guardrails und verwenden Sie /api/v1/guardrail_assignments, um sie zuzuweisen oder zu entfernen. Behandeln Sie eine abgelehnte Zuweisung als Richtlinien- oder Eigentümerfehler, anstatt stillschweigend ohne den Guardrail fortzufahren.

Verwaltungsfehler behandeln

401 Unauthorized bedeutet, dass die Anmeldeinformation fehlt, fehlerhaft formatiert, widerrufen oder ungültig ist.
403 Forbidden bedeutet, dass die Berechtigungsklasse oder Kontorolle den Vorgang nicht ausführen darf.
404 Not Found bedeutet, dass die angeforderte Ressource für das authentifizierte Konto nicht sichtbar ist.
422 Unprocessable Content bedeutet, dass einer oder mehrere übermittelte Werte gegen eine Ressourcenregel verstoßen.