Mit einem API-Schlüssel authentifizieren

Auf dieser Seite wird beschrieben, wie Sie sich beim CLEVI-Gateway mit einem API-Schlüssel authentifizieren.
Für den OpenAI-kompatiblen und den Anthropic-kompatiblen Pfad erfolgt die Authentifizierung jeweils mit einem einzigen Schlüssel.
Der zulässige Header für den Schlüssel und die im SDK festzulegende base URL unterscheiden sich je nach Spezifikation.

Authentifizierungs-Header

Beide kompatiblen Spezifikationen verwenden zur Authentifizierung einen einzigen API-Schlüssel. Der Schlüssel wird in der API-Schlüssel-Ansicht der Konsole ausgestellt. In derselben Ansicht können Sie ihn widerrufen und seinen Nutzungsumfang verwalten.

Bei Header-Namen wird nicht zwischen Groß- und Kleinschreibung unterschieden. Auch das vom Anthropic SDK gesendete x-api-key funktioniert unverändert.

base URL

Bei bereits verwendeten SDKs müssen Sie lediglich die base URL auf die unten angegebene Adresse ändern. Die beiden Adressen unterscheiden sich darin, ob sie /v1 enthalten.

Authentifizierung überprüfen

Wenn Sie den Schlüssel und die base URL eintragen und die Modellliste abrufen, können Sie sofort feststellen, ob die Authentifizierung erfolgreich war. Die drei folgenden Beispiele führen dieselbe Abfrage mit curl, dem OpenAI SDK und dem Anthropic SDK durch.

curl https://platform.clevi.net/api/v2/aiservice/openai/v1/models \
  -H "X-API-Key: sk-..."

curl https://platform.clevi.net/api/v2/aiservice/anthropic/v1/models \
  -H "Authorization: Bearer sk-..." \
  -H "anthropic-version: 2023-06-01"

from openai import OpenAI

client = OpenAI(
    api_key="sk-...",
    base_url="https://platform.clevi.net/api/v2/aiservice/openai/v1",
)

for model in client.models.list():
    print(model.id)

from anthropic import Anthropic

client = Anthropic(
    api_key="sk-...",
    base_url="https://platform.clevi.net/api/v2/aiservice/anthropic",
)

for model in client.models.list(limit=20).data:
    print(model.id)

Anstelle von sk-... setzen Sie den in der API-Schlüssel-Ansicht ausgestellten Schlüssel ein.

• Bei einer Antwort mit Status 200 war die Authentifizierung erfolgreich. data enthält die Liste der Modelle, die mit diesem Schlüssel aufgerufen werden können.
• Bei einer Antwort mit Status 401 prüfen Sie die Punkte in der Reihenfolge des Abschnitts „Authentifizierung fehlgeschlagen“.

Gemeinsam verwendete Header

Alle Angaben sind optional. Für die Fehlerverfolgung empfiehlt es sich jedoch, X-Request-Id mitzusenden.

Authentifizierung fehlgeschlagen

Wenn kein Schlüssel vorhanden ist oder ein abgelaufener bzw. widerrufener Schlüssel gesendet wird, lautet die Antwort 401. Wenn in einem OpenAI-kompatiblen Pfad ohne Schlüssel aufgerufen wird, wird der folgende Text zurückgegeben. Der error.type im Anthropic-kompatiblen Pfad lautet authentication_error.

{
  "error": {
    "message": "API key is required.",
    "type": "invalid_request_error"
  }
}

1. Überprüfen Sie den Schlüsselstatus auf der API-Schlüsselseite. Stellen Sie einen neuen Schlüssel aus, wenn der aktuelle abgelaufen oder widerrufen ist.
2. Überprüfen Sie, ob der Header X-API-Key oder Authorization heißt.
3. Wenn Sie im OpenAI-kompatiblen Pfad Authorization verwenden, überprüfen Sie das Präfix Bearer.