Developer guide
Autentisering med API-nøkkel
Headeren som inneholder API-nøkkelen, og base URL-en som skal angis i SDK-en
Denne siden beskriver hvordan du autentiserer med en API-nøkkel mot CLEVI-gatewayen.
Både den OpenAI-kompatible og den Anthropic-kompatible banen autentiserer med én nøkkel,
men det tillatte området for headeren som inneholder nøkkelen, og base URL-en som skal angis i SDK-en, varierer mellom spesifikasjonene.
Autentiseringsheader
Begge kompatible spesifikasjoner autentiserer med én API-nøkkel. Nøkkelen utstedes på API-nøkkelsiden i konsollen, og på samme side kan du administrere tilbakekalling og bruksområde.
| Header | OpenAI-kompatibel | Anthropic-kompatibel |
|---|---|---|
| X-API-Key: <키> | Tillatt | Tillatt |
| Authorization: Bearer <키> | Tillatt | Tillatt |
| Authorization: <키> (uten Bearer) | Avvist | Tillatt |
Headernavn skiller ikke mellom store og små bokstaver. x-api-key som sendes av Anthropic SDK, fungerer også uendret.
base URL
SDK-en du allerede bruker, fungerer uendret når du bare endrer base URL til adressen nedenfor. De to adressene skiller seg fra hverandre ved om de inkluderer /v1.
| Spesifikasjon | base URL | Regler for bane |
|---|---|---|
| OpenAI-kompatibel | https://platform.clevi.net/api/v2/aiservice/openai/v1 | Inkluder /v1 i base URL-en. |
| Anthropic-kompatibel | https://platform.clevi.net/api/v2/aiservice/anthropic | Anthropic SDK legger selv til /v1 i banen, så den avsluttes før /v1. |
Kontrollere autentisering
Du kan umiddelbart kontrollere om autentiseringen er vellykket ved å angi nøkkelen og base URL-en og hente modellisten. De tre eksemplene nedenfor utfører samme forespørsel 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)Sett inn nøkkelen som er utstedt på API-nøkkelsiden, i stedet for sk-....
- Hvis svaret er 200, er autentiseringen vellykket. data inneholder en liste over modellene som kan kalles med denne nøkkelen.
- Hvis svaret er 401, følger du rekkefølgen i delen om mislykket autentisering nedenfor.
Headere som brukes sammen
Alle er valgfrie. For å spore problemer anbefales det å inkludere X-Request-Id.
| Topptekst | Bruksområde | Hvis den utelates |
|---|---|---|
| X-Request-Id | Identifikator for forespørselssporing. Returneres som request-id-topptekst i Anthropic-kompatible svar. | Utstedes av serveren. |
| X-Region-Code | Regionen som kallet gjøres til | global. |
| X-Product-Sku (kan også angis som product_sku i spørringen) | Angir Product SKU-en som skal brukes til fakturering, direkte. Toppteksten har prioritet over spørringen og brukes hovedsakelig for tale- og voice-ruter. | Kreves for voice-ruter. For audio/speech og audio/transcriptions velges Product med model i brødteksten. |
| anthropic-version / anthropic-beta | Videreformidles uendret i Anthropic-kompatible ruter. | Versjonen er 2023-06-01. |
Autentiseringsfeil
Hvis du sender en manglende, utløpt eller tilbakekalt nøkkel, får du 401. Hvis du kaller en OpenAI-kompatibel rute uten nøkkel, returneres brødteksten nedenfor, og error.type i Anthropic-kompatible ruter er authentication_error.
{
"error": {
"message": "API key is required.",
"type": "invalid_request_error"
}
}- Kontroller nøkkelstatusen på API-nøkkelsiden. Utsted en ny nøkkel hvis den er utløpt eller tilbakekalt.
- Kontroller om topptekstnavnet er X-API-Key eller Authorization.
- Hvis du bruker Authorization i en OpenAI-kompatibel rute, må du kontrollere Bearer-prefikset.