- Anfragen an Novita AI mit einem Bearer-API-Schlüssel authentifizieren.
- einen API-Schlüssel in der Konsole erstellen und sicher speichern.
- den Schlüssel als Umgebungsvariable unter Linux, macOS oder Windows festlegen.
- prüfen, wie lange ein Schlüssel gültig bleibt und welche Schlüsselvorgänge die OpenAPI unterstützt.
- Modell- und Netzwerkzugriffsrichtlinien für einen Schlüssel konfigurieren.
Authentifizierung
Novita AI verwendet die Bearer-Authentifizierung für den API-Zugriff. Senden Sie Ihren API-Schlüssel imAuthorization-Anfrage-Header:
API-Schlüssel erstellen
1
Schlüsselverwaltung öffnen
Gehen Sie in der Konsole zu Schlüsselverwaltung.
2
Neuen Schlüssel erstellen
Wählen Sie API-Schlüssel erstellen, und geben Sie dem Schlüssel dann einen Namen, der seinen Zweck widerspiegelt, z. B.
production oder local-testing.3
Schlüssel kopieren und speichern
Der vollständige Schlüssel wird nur einmal angezeigt, und zwar bei seiner Erstellung. Kopieren Sie ihn sofort und bewahren Sie ihn an einem sicheren Ort auf, z. B. in einem Secrets Manager oder in einer Umgebungsvariablen. Wenn Sie ihn verlieren, können Sie ihn nicht wiederherstellen; erstellen Sie stattdessen einen neuen Schlüssel.
Zugriffssteuerungen konfigurieren
Zugriffssteuerungen sind optional und werden pro API-Schlüssel konfiguriert:- Modellzugriff für API-Schlüssel steuert, welche Modelle ein Schlüssel innerhalb des für Ihr Team aktivierten Modellbereichs aufrufen kann.
- Netzwerkzugriff für API-Schlüssel steuert, welche Quell-IPs einen Schlüssel für den Modellaufruf verwenden können.
Schlüsselformat und Gültigkeit
- Jeder Schlüssel beginnt mit dem Präfix
sk_. - Ein Schlüssel wird nur einmal vollständig angezeigt, und zwar bei seiner Erstellung. Danach zeigt die Konsole eine maskierte Form.
- Jedes Konto kann bis zu 10 API-Schlüssel erstellen.
Sie legen den Ablauf beim Erstellen des Schlüssels fest. Er kann danach nicht geändert werden: Sie können einen Schlüssel weder verlängern noch sofort ablaufen lassen. Dauerhafte Schlüssel bleiben unbegrenzt gültig, daher bleibt ein geleakter Schlüssel länger verwendbar. Verwenden Sie dauerhafte Schlüssel nur, wenn es angemessen ist. Der Ablauf wird nur in der Konsole konfiguriert; die OpenAPI erstellt keine Schlüssel und legt deren Ablauf nicht fest, ändert ihn nicht und entfernt ihn nicht.
Was die OpenAPI abdeckt
Sie erstellen und löschen API-Schlüssel nur in der Konsole. Die Novita OpenAPI hat keine Endpunkte zum Erstellen oder Löschen von Schlüsseln und unterstützt das Konfigurieren des Ablaufs eines Schlüssels nicht. Die schlüsselbezogenen OpenAPI-Endpunkte ermöglichen es Ihnen, Schlüssel aufzulisten und ihre Modell- und Netzwerkzugriffsrichtlinien zu verwalten:- API-Schlüssel auflisten — listet die Schlüssel in Ihrem Team auf, mit einer optionalen Zusammenfassung des Modellzugriffs.
- Modellzugriffsrichtlinie für API-Schlüssel abrufen — liest die Modellzugriffsrichtlinie eines einzelnen Schlüssels.
- Modellzugriffsrichtlinie für API-Schlüssel festlegen — legt die Modellzugriffsrichtlinie eines Schlüssels fest oder aktualisiert sie.
- Modellzugriffsrichtlinie für API-Schlüssel zurücksetzen — setzt die Modellzugriffsrichtlinie eines Schlüssels auf die Standardeinstellung zurück. Dies setzt nur die Richtlinie zurück; der Schlüssel selbst wird nicht gelöscht.
- IP-Zugriffsrichtlinie für API-Schlüssel abrufen — liest die Netzwerkzugriffsrichtlinie eines einzelnen Schlüssels.
- IP-Zugriffsrichtlinie für API-Schlüssel festlegen — legt die erlaubten Quell-IPs eines Schlüssels fest oder aktualisiert sie.
- IP-Zugriffsrichtlinie für API-Schlüssel löschen — löscht die Netzwerkzugriffsrichtlinie eines Schlüssels, sodass keine Quell-IP-Beschränkung mehr gilt.
Schlüssel als Umgebungsvariable speichern
Wenn Sie einen Schlüssel im Quellcode fest codieren, kann er offengelegt werden, beispielsweise wenn Sie die Datei committen. Wenn Sie ihn aus einer Umgebungsvariablen wieNOVITA_API_KEY lesen, bleibt er aus Ihrem Quellcode heraus.
Temporär vs. dauerhaft
Ein Schlüssel, der mitexport (Linux/macOS) oder set (Windows) festgelegt wurde, gilt nur für die aktuelle Terminalsitzung und ist verschwunden, wenn Sie sie schließen. Das eignet sich für einen schnellen Test. Um den Schlüssel sitzungsübergreifend beizubehalten, legen Sie ihn wie unten gezeigt dauerhaft fest und öffnen Sie dann ein neues Terminal, damit die Änderung wirksam wird.
Die Variable ist festgelegt, aber der Code findet sie immer noch nicht
Sie haben ihn temporär festgelegt und ein neues Terminal geöffnet
Sie haben ihn temporär festgelegt und ein neues Terminal geöffnet
Ein Schlüssel, der mit
export oder $env: festgelegt wurde, existiert nur in der Terminalsitzung, in der Sie den Befehl ausgeführt haben. Ein neues Terminal oder ein neuer Tab erbt ihn nicht. Legen Sie den Schlüssel dauerhaft fest (>> ~/.zshrc, setx), oder führen Sie den Befehl export/$env: erneut in der Sitzung aus, die Sie verwenden.Sie haben ihn dauerhaft festgelegt, aber nicht neu gestartet
Sie haben ihn dauerhaft festgelegt, aber nicht neu gestartet
Eine dauerhafte Änderung (ein Shell-Profil oder
setx) gilt für Terminals, die nach der Änderung gestartet wurden. Öffnen Sie ein neues Terminal und starten Sie dann Ihre IDE oder Ihren Editor neu, damit sie die aktualisierte Umgebung lesen können. Unter Windows wirkt sich setx nicht auf Terminals aus, die bereits geöffnet sind.Ein Dienstmanager erbt Ihre Shell-Umgebung nicht
Ein Dienstmanager erbt Ihre Shell-Umgebung nicht
Von
systemd, supervisor, Docker oder einem CI-Runner gestartete Prozesse lesen Ihr interaktives Shell-Profil nicht. Legen Sie die Variable in der eigenen Konfiguration des Dienstes fest, z. B. in einer systemd-Unit Environment=, in einem docker run -e-Flag oder in den Secrets des CI-Projekts, und nicht in ~/.bashrc.Sie haben den Befehl unter sudo ausgeführt
Sie haben den Befehl unter sudo ausgeführt
sudo übergibt Ihre Umgebung standardmäßig nicht, daher ist eine Variable, die von Ihrem Benutzer exportiert wurde, für den erhöhten Prozess nicht sichtbar. Verwenden Sie sudo -E, um die Umgebung beizubehalten, oder legen Sie die Variable im erhöhten Kontext fest.Verwandte Themen
- Häufige Fehlercodes — lösen Sie
401- und403-Antworten im Zusammenhang mit Schlüsseln auf. - Rate-Limits — Anfrage- und Token-Limits, die für Ihr Konto gelten.