Developer guide
Godkendelse med API-nøgle
Headeren, der indeholder API-nøglen, og den base URL, der skal indstilles i SDK'et
Denne side beskriver, hvordan du godkender med en API-nøgle via CLEVI-gatewayen.
Både OpenAI-kompatible og Anthropic-kompatible endpoints godkender med én nøgle,
men de tilladte headere til nøglen og den base URL, der skal indstilles i SDK'et, varierer efter specifikation.
Godkendelsesheader
Begge kompatible specifikationer godkender med én API-nøgle. Nøglen udstedes på API-nøglesiden i konsollen, hvor du også kan tilbagekalde den og administrere dens anvendelsesområde.
| Header | OpenAI-kompatibel | Anthropic-kompatibel |
|---|---|---|
| X-API-Key: <nøgle> | Accepteret | Accepteret |
| Authorization: Bearer <nøgle> | Accepteret | Accepteret |
| Authorization: <nøgle> (uden Bearer) | Afvist | Accepteret |
Headernavne skelner ikke mellem store og små bogstaver. x-api-key, som Anthropic SDK sender, fungerer også uændret.
base URL
De SDK'er, du allerede bruger, fungerer uændret, hvis du kun ændrer base URL til adressen nedenfor. De to adresser adskiller sig ved, om de indeholder /v1.
| Specifikation | base URL | Regel for sti |
|---|---|---|
| OpenAI-kompatibel | https://platform.clevi.net/api/v2/aiservice/openai/v1 | Inkluder /v1 i base URL. |
| Anthropic-kompatibel | https://platform.clevi.net/api/v2/aiservice/anthropic | Anthropic SDK tilføjer selv /v1 til stien, så den slutter før /v1. |
Kontrol af godkendelse
Du kan straks kontrollere, om godkendelsen lykkes, ved at indsætte nøglen og base URL og hente modellisten. De tre nedenstående eksempler udfører den samme forespørgsel med curl, OpenAI SDK og Anthropic SDK.
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)I stedet for sk-... skal du indsætte den nøgle, der er udstedt på API-nøglesiden.
- Hvis svaret er 200, er godkendelsen gennemført. data indeholder listen over modeller, som kan kaldes med denne nøgle.
- Hvis svaret er 401, skal du kontrollere i den rækkefølge, der er angivet i afsnittet om godkendelsesfejl nedenfor.
Headere, der bruges sammen
Alle er valgfri. For at kunne spore problemer anbefales det at inkludere X-Request-Id.
| Header | Anvendelse | Hvis den udelades |
|---|---|---|
| X-Request-Id | Identifikator til sporing af anmodninger. I Anthropic-kompatible svar returneres den som request-id-headeren. | Udstedes af serveren. |
| X-Region-Code | Regionen for kaldet | Er global. |
| X-Product-Sku (kan også angives som forespørgslen product_sku) | Angiver direkte den Product SKU, der skal bruges til fakturering. Headeren har prioritet over forespørgslen og bruges primært til voice- og tale-stier. | På voice-stier er den nødvendig. audio/speech og audio/transcriptions vælger Product via model i brødteksten. |
| anthropic-version / anthropic-beta | Videregives uændret på Anthropic-kompatible stier. | Versionen er 2023-06-01. |
Godkendelsesfejl
Hvis du sender en manglende, udløbet eller tilbagekaldt nøgle, returneres 401. Hvis du kalder en OpenAI-kompatibel sti uden en nøgle, returneres nedenstående brødtekst, og error.type på Anthropic-kompatible stier er authentication_error.
{
"error": {
"message": "API key is required.",
"type": "invalid_request_error"
}
}- Kontrollér nøglens status på siden med API-nøgler. Udsted en ny nøgle, hvis den er udløbet eller tilbagekaldt.
- Kontrollér, om headernavnet er X-API-Key eller Authorization.
- Hvis du bruger Authorization på en OpenAI-kompatibel sti, skal du kontrollere Bearer-præfikset.