Zum Hauptinhalt springen
Ein Admin-Schlüssel kann alle Ihre anderen API-Schlüssel über die API verwalten. Geben Sie jeder App, jeder Umgebung und jedem Kunden einen eigenen Inference-Schlüssel, begrenzen Sie, wie viel jeder davon ausgeben darf, verfolgen Sie die Nutzung pro Schlüssel und ändern oder widerrufen Sie Schlüssel, ohne das Dashboard zu öffnen.

Erstellen

Einen Schlüssel mit Ausgabenlimit ausstellen

Überwachen

Sehen, was jeder Schlüssel ausgibt

Ändern

Ein Limit erhöhen oder ein Ablaufdatum verlängern

Widerrufen

Einen Schlüssel sofort sperren

So funktioniert es

Admin-SchlüsselIhr SteuerungsschlüsselErstellt, ändert und widerruft SchlüsselLiest Nutzung und AbrechnungBleibt auf Ihrem Server
Inferencecust:acme50 $ / MonatNur private Modelle
Inferencecust:globex5 $ / MonatNur von 11.22.33.0/24
Inferencestaging10 $ / TagLäuft am 30. Juni ab
Admin-Schlüssel können jeden Endpunkt aufrufen, einschließlich derjenigen, die Schlüssel verwalten und Abrechnungsdaten lesen. Inference-Schlüssel können Modelle aufrufen, aber weder Schlüssel verwalten noch Abrechnungsdaten lesen – daher sind sie die Schlüssel, die Sie weitergeben.
Erstellen Sie Ihren ersten Admin-Schlüssel im Dashboard: Folgen Sie der Anleitung API-Schlüssel generieren und wählen Sie Admin als Schlüsseltyp. Bewahren Sie ihn in einem serverseitigen Secret-Speicher auf, niemals in Client-Code.
Die Beispiele auf dieser Seite lesen den Admin-Schlüssel aus VENICE_ADMIN_KEY:

Einen Schlüssel erstellen

Dies erstellt einen Inference-Schlüssel für einen Kunden, begrenzt auf 50 $ pro Monat und mit Ablauf am 30. Juni 2027:
Response
data.apiKey ist der geheime Wert des Schlüssels, und diese Antwort ist das einzige Mal, dass Sie ihn sehen. Speichern Sie ihn sofort. Wenn er verloren geht, widerrufen Sie den Schlüssel und erstellen Sie einen neuen. Bewahren Sie auch data.id auf: Jeder andere Aufruf auf dieser Seite verwendet sie.

Schlüsseleinstellungen

Legen Sie diese beim Erstellen eines Schlüssels fest oder ändern Sie sie später mit PATCH /api_keys. Der Request-Body wird strikt geprüft, daher gibt ein unbekanntes Feld 400 zurück. Sie können bis zu 20 Schlüssel pro Minute erstellen und bis zu 500 aktive Schlüssel besitzen. Wenden Sie sich an den Support, wenn Sie mehr benötigen.
Sie entwickeln einen Agenten? Eine Wallet mit gestakten VVV auf Base kann ihren eigenen Schlüssel ohne Venice-Konto erstellen. Siehe Erstellung von API-Schlüsseln für autonome Agenten.

Nutzung überwachen

Ein Schlüssel

Response (trimmed)
Dieser Schlüssel hat 12,50 seiner50seiner 50 für den Monat verbraucht. currentPeriodUsage erscheint nur bei Schlüsseln mit einem USD- oder DIEM-Limit, und Nutzungsbeträge sind Strings mit vier Dezimalstellen. Antworten geben consumptionLimits (Plural) zurück, während Anfragen consumptionLimit (Singular) senden.

Ausgaben pro Schlüssel im Zeitverlauf

GET /billing/usage-analytics gibt Summen pro Schlüssel in byKey und eine Zeile pro Tag in byKeyDaily zurück – bereit für Diagramme. Übergeben Sie lookback (standardmäßig 7d, bis zu 90d) oder ein Paar aus startDate und endDate, das bis zu 90 Tage umfasst. Ergebnisse werden 10 Minuten lang zwischengespeichert.
cURL
Response (trimmed)

Jede Belastung pro Schlüssel

GET /billing/usage-history listet jede Belastung auf, und jeder Eintrag enthält die apiKeyId, der sie berechnet wurde. Verwenden Sie dies, um Ausgaben abzugleichen oder Ihre eigenen Kunden abzurechnen. Einträge werden beginnend mit dem ältesten zurückgegeben. Senden Sie nextCursor allein als cursor zurück, bis der Wert null ist. Senden Sie Accept: text/csv, um stattdessen CSV zu erhalten.
Belastungen haben einen negativen amount, daher zieht die Schleife ihn ab, um eine positive Summe pro Schlüssel und Währung zu erhalten. Einträge ohne apiKeyId stammen aus der Venice-Web-App oder sind Kontoeinträge wie Credit-Käufe.

Ob ein Schlüssel gerade Ausgaben tätigen kann

GET /api_keys/rate_limits funktioniert mit jedem Schlüssel und gibt Auskunft über den Schlüssel, der ihn aufruft. accessPermitted gibt an, ob der Schlüssel gerade Ausgaben tätigen kann, und balances zeigt, wie viel er noch ausgeben kann.
cURL
GET /api_keys/rate_limits/log gibt mit einem Admin-Schlüssel Ihre letzten 50 Ratenlimit-Treffer zurück, jeweils mit apiKeyId und modelId.

Limits und Einstellungen ändern

Senden Sie die id des Schlüssels und nur die Felder, die Sie ändern möchten. Alles andere bleibt unverändert. Dies erhöht das Limit auf 100 $ pro Monat:
Senden Sie stattdessen eines dieser Felder, um andere Änderungen vorzunehmen: Eine neue limitPeriod gilt sofort, sodass ein Wechsel zu LIFETIME alle bisherigen Ausgaben des Schlüssels auf das Limit anrechnet. apiKeyType kann nicht geändert werden; erstellen Sie stattdessen einen neuen Schlüssel.

Einen Schlüssel widerrufen oder rotieren

Die Antwort lautet { "success": true }. Der Widerruf erfolgt sofort: Die nächste Anfrage des Schlüssels erhält 401 Authentication failed, und der Schlüssel erscheint nicht mehr in GET /api_keys. Seine bisherigen Belastungen bleiben im Nutzungsverlauf erhalten. So rotieren Sie einen Schlüssel ohne Ausfallzeit:
1

Ersatz erstellen

Erstellen Sie einen neuen Schlüssel mit denselben Einstellungen und speichern Sie seinen geheimen Wert.
2

Bereitstellen

Stellen Sie Ihre App auf den neuen geheimen Wert um.
3

Alten Schlüssel widerrufen

Sobald sich lastUsedAt des alten Schlüssels in GET /api_keys nicht mehr ändert, löschen Sie ihn.

Fehler, die Ihre Aufrufer sehen können

Siehe Fehlercodes für die vollständige Liste.

Best Practices

  • Bewahren Sie Admin-Schlüssel auf Ihrem Server auf und geben Sie nur Inference-Schlüssel weiter.
  • Geben Sie jeder App, jeder Umgebung und jedem Kunden einen eigenen Schlüssel, damit jeder einzeln überwacht und widerrufen werden kann.
  • Tragen Sie Ihre eigene Kennung in description ein. Die Nutzungsanalyse beschriftet Schlüssel damit.
  • Versehen Sie jeden Schlüssel, den Sie an andere weitergeben, mit einem Limit und einem Ablaufdatum, und beschränken Sie Server-zu-Server-Schlüssel mit ipAllowlist auf Ihre IPs.

API-Referenz

API-Schlüssel erstellen

Alle beim Erstellen akzeptierten Felder.

API-Schlüssel aktualisieren

Limits, Ablaufdatum, Datenschutz und IPs ändern.

API-Schlüssel auflisten

Jeder aktive Schlüssel mit seiner Nutzung.

API-Schlüssel löschen

Einen Schlüssel widerrufen.

Nutzungsanalyse

Ausgaben nach Schlüssel, Modell und Tag.

Nutzungsverlauf

Jede Belastung mit ihrem API-Schlüssel.