Godkendelse med en API-nøgle

CLEVI-gatewayen godkender OpenAI-kompatible stier og Anthropic-kompatible stier med én API-nøgle.
Der er to værdier, der skal indstilles på klienten: godkendelsesheaderen, som indeholder nøglen, og SDK'ets base-URL. De tilladte headere og base-URL'er varierer afhængigt af specifikationen.
Når indstillingerne er gennemført, kan du straks kontrollere, om godkendelsen fungerer, ved at hente modellisten.
Hvis godkendelsen mislykkes, returneres 401. Hvis godkendelsen lykkes, men kravene til tilladelser eller grænser ikke er opfyldt, returneres 403.

Udsted en API-nøgle på API-nøglesiden i konsollen. På samme side kan du administrere tilbagekaldelse af nøglen og dens anvendelsesområde.

Godkendelsesheader

Begge specifikationer indeholder API-nøglen i én request-header. Brug enten X-API-Key-headeren eller Authorization-headeren. Det tilladte format afhænger af specifikationen.

Når du bruger Authorization-headeren med en OpenAI-kompatibel sti, kræves præfikset Bearer. Hvis du kun sender nøglen uden præfikset, afviser gatewayen anmodningen.

Headernavne skelner ikke mellem store og små bogstaver, så x-api-key-headeren, som Anthropic SDK sender, fungerer også uændret. Hvis begge headere angives, bruges værdien i X-API-Key først.

base-URL

Eksisterende SDK'er kan fortsat bruges ved blot at ændre base-URL'en til en af adresserne nedenfor. De to adresser adskiller sig ved, om de indeholder /v1, så angiv den adresse, der svarer til specifikationen, uændret.

Kontrol af godkendelse

Når du har angivet nøglen og base URL, kan du kontrollere godkendelsen ved at hente en liste over modeller. Eksemplerne nedenfor udfører den samme forespørgsel med curl, OpenAI SDK og Anthropic SDK. Indsæt den nøgle, du har udstedt på siden med API-nøgler, i stedet for sk-....

Når du henter listen med curl, skal du angive den fulde sti til og med /v1/models for begge specifikationer. Den første kommando bruger headeren X-API-Key til den OpenAI-kompatible sti, og den anden kommando bruger headeren Authorization til den Anthropic-kompatible sti.

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"

OpenAI SDK angiver en adresse, der inkluderer /v1, i base_url.

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)

Anthropic SDK angiver en base_url, der slutter før /v1.
Til godkendelse bruges x-api-key-headeren, som SDK'et sender, uændret.

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)

Hvis svaret er 200 i et af eksemplerne, er godkendelsen gennemført, og response.data indeholder en liste over de modeller, der kan kaldes med denne nøgle. Hvis svaret er 401, skal du kontrollere årsagen i den rækkefølge, der er beskrevet i næste afsnit.

Godkendelse mislykkedes

Hvis du sender en manglende, udløbet eller tilbagekaldt nøgle, returneres 401. Hvis du kalder den OpenAI-kompatible sti uden en nøgle, returneres nedenstående brødtekst, mens error.type er authentication_error i den Anthropic-kompatible sti.

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

Hvis du modtager 401, skal du kontrollere følgende i rækkefølge.

1. Kontrollér nøglens status på siden med API-nøgler. Hvis nøglen er udløbet eller tilbagekaldt, skal du udstede en ny.
2. Kontrollér, om headernavnet er X-API-Key eller Authorization.
3. Hvis du bruger headeren Authorization på den OpenAI-kompatible sti, skal du kontrollere, om den har præfikset Bearer.

Kør forespørgslen efter modelisten i afsnittet om kontrol af godkendelse igen efter ændringen, og kontrollér, om du modtager 200.

Headere, der bruges sammen

Alle følgende headere er valgfri. Vi anbefaler, at du angiver X-Request-Id, så problemer kan spores.

Hvis 5xx-fejl gentager sig, bedes du give os besked via Hjælp og Kontakt sammen med X-Request-Id. Hvis værdien er angivet direkte, kan den sammenholdes direkte med klientloggene.