Developer guide
Mat engem API-Schlëssel authentifizéieren
Den Header, an deem den API-Schlëssel steet, an d'base URL, déi am SDK festgeluecht gëtt
Op dëser Säit gëtt erkläert, wéi een sech beim CLEVI-Gateway mat engem API-Schlëssel authentifizéiert.
Souwuel de kompatibele OpenAI-Wee wéi och de kompatibele Anthropic-Wee benotzen ee Schlëssel fir d'Authentifizéierung,
mee den erlaabte Beräich vum Header, an deem de Schlëssel steet, an d'base URL, déi am SDK festgeluecht gëtt, ënnerscheede sech jee no Spezifikatioun.
Authentifizéierungsheader
Béid kompatibel Spezifikatioune authentifizéieren mat engem eenzegen API-Schlëssel. De Schlëssel gëtt op der API-Schlëssel-Säit an der Konsole ausgestallt; op därselwechter Säit kënne Réckzuch an Asazberäich verwalt ginn.
| Header | OpenAI-kompatibel | Anthropic-kompatibel |
|---|---|---|
| X-API-Key: <키> | Verfügbar | Verfügbar |
| Authorization: Bearer <키> | Verfügbar | Verfügbar |
| Authorization: <키> (ouni Bearer) | Ofgeleent | Verfügbar |
Den Numm vum Header ënnerscheet net tëscht Grouss- a Klengschreiwung. Och x-api-key, dat vum Anthropic SDK geschéckt gëtt, funktionéiert onverännert.
base URL
Äert bestehend SDK funktionéiert weider, wann Dir nëmmen d'base URL op déi folgend Adress ännert. Déi zwou Adressen ënnerscheede sech doran, ob si /v1 enthalen.
| Spezifikatioun | base URL | Wee-Regel |
|---|---|---|
| OpenAI-kompatibel | https://platform.clevi.net/api/v2/aiservice/openai/v1 | /v1 muss an der base URL abegraff sinn. |
| Anthropic-kompatibel | https://platform.clevi.net/api/v2/aiservice/anthropic | Den Anthropic SDK setzt /v1 automatesch un de Wee dobäi, dofir hält d'base URL virun /v1 op. |
Authentifizéierung iwwerpréiwen
Wann Dir de Schlëssel an d'base URL agitt an d'Modellëscht ofrufft, kënnt Dir direkt erkennen, ob d'Authentifizéierung erfollegräich war. Déi dräi Beispiller hei ënnen maachen déiselwecht Ofruff mat curl, dem OpenAI SDK an dem 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)Op der Plaz sk-... setzt Dir de Schlëssel an, deen op der API-Schlëssel-Säit ausgestallt gouf.
- Wann d'Äntwert 200 ass, war d'Authentifizéierung erfollegräich. data enthält d'Lëscht vun de Modeller, déi mat dësem Schlëssel opgeruff kënne ginn.
- Wann d'Äntwert 401 ass, iwwerpréift d'Probleem no der Reiefolleg am Abschnitt iwwer d'Authentifizéierungsfeeler hei ënnen.
Zesumme benotzten Header
Alles ass fakultativ. Fir Problemer ze verfollegen, ass et sënnvoll, X-Request-Id matzeschécken.
| Header | Zweck | Wann e weggelooss gëtt |
|---|---|---|
| X-Request-Id | Identifikateur fir d'Verfollegung vun der Ufro. Bei Anthropic-kompatiblen Äntwerte kënnt en als request-id-Header zréck. | De Server stellt en aus. |
| X-Region-Code | Regioun vum Opruff | global ass de Wäert. |
| X-Product-Sku (och mam Query-Parameter product_sku méiglech) | Gëtt de Product SKU fir d'Ofrechnung direkt un. Den Header huet Virrang virum Query-Parameter a gëtt haaptsächlech bei Voice- a Stëmmweeër benotzt. | Bei Voice-Weeër ass en néideg. audio/speech an audio/transcriptions wielen de Product mam model am Kierper aus. |
| anthropic-version / anthropic-beta | Gëtt um Anthropic-kompatibele Wee onverännert weidergeleet. | D'Versioun ass 2023-06-01. |
Authentifikatioun feelgeschloen
Wann Dir kee Schlëssel oder en ofgelafenen oder annuléierte Schlëssel schéckt, kritt Dir 401. Wann Dir um OpenAI-kompatibele Wee ouni Schlëssel oprufft, kritt Dir de Kierper hei ënnen, an den error.type um Anthropic-kompatibele Wee ass authentication_error.
{
"error": {
"message": "API key is required.",
"type": "invalid_request_error"
}
}- Kontrolléiert de Status vum Schlëssel op der API-Schlëssel-Säit. Wann de Schlëssel ofgelaf oder annuléiert ass, generéiert en neien.
- Kontrolléiert, ob den Numm vum Header X-API-Key oder Authorization ass.
- Wann Dir um OpenAI-kompatibele Wee Authorization benotzt, kontrolléiert de Bearer-Präfix.