Developer guide
Autentisearje mei in API-kaai
De koptekst wêryn jo de API-kaai pleatse en de base URL dy't jo yn 'e SDK ynstelle
Op dizze side wurdt behannele hoe't jo by de CLEVI-gateway autentisearje mei in API-kaai.
Sawol it OpenAI-kompatibele paad as it Anthropic-kompatibele paad autentisearje mei ien kaai,
mar it tastiene berik fan 'e koptekst wêryn jo de kaai pleatse en de base URL dy't jo yn 'e SDK ynstelle, ferskille per spesifikaasje.
Autentikaasjekoptekst
Beide kompatibele spesifikaasjes autentisearje mei ien API-kaai. De kaai wurdt útjûn op it skerm foar API-kaaien yn 'e konsole; op itselde skerm kinne jo it ynlûken en it gebrûksberik beheare.
| Koptekst | OpenAI-kompatibel | Anthropic-kompatibel |
|---|---|---|
| X-API-Key: <kaai> | Beskikber | Beskikber |
| Authorization: Bearer <kaai> | Beskikber | Beskikber |
| Authorization: <kaai> (sûnder Bearer) | Ofwiisd | Beskikber |
De namme fan 'e koptekst is net haadlettergefoelich. x-api-key, dat troch de Anthropic SDK ferstjoerd wurdt, wurket ek sa.
base URL
De SDK dy't jo al brûke, bliuwt wurkjen as jo allinnich de base URL feroarje nei it ûndersteande adres. It ferskil tusken de twa adressen is oft se /v1 befetsje.
| Spesifikaasje | base URL | Regels foar paden |
|---|---|---|
| OpenAI-kompatibel | https://platform.clevi.net/api/v2/aiservice/openai/v1 | Omfetsje oant en mei /v1 yn 'e base URL. |
| Anthropic-kompatibel | https://platform.clevi.net/api/v2/aiservice/anthropic | De Anthropic SDK foeget /v1 sels oan it paad ta, dus it einiget foar /v1. |
Autentikaasje kontrolearje
Jo kinne daliks sjen oft de autentikaasje slagge is troch de modellist op te freegjen mei de kaai en de base URL ynsteld. De trije foarbylden hjirûnder dogge deselde opfraach mei curl, de OpenAI SDK en de 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)Pleats op it plak fan sk-... de kaai dy't jo op it skerm foar API-kaaien útjûn hawwe.
- As it antwurd 200 is, is de autentikaasje slagge. data befettet de list mei modellen dy't jo mei dizze kaai oproppe kinne.
- As it antwurd 401 is, kontrolearje dan neffens de folchoarder yn 'e seksje oer mislearre autentikaasje hjirûnder.
Mei-inoar brûkte koptekst
Alles is opsjoneel. Om problemen te folgjen is it oan te rieden om X-Request-Id ta te foegjen.
| Header | Doel | As it weilitten wurdt |
|---|---|---|
| X-Request-Id | Identifier foar it folgjen fan fersiken. By Anthropic-kompatibele antwurden wurdt it weromjûn as de request-id-header. | Wurdt troch de server útjûn. |
| X-Region-Code | Regio fan de oprop | global. |
| X-Product-Sku (kin ek as de query product_sku brûkt wurde) | Jout de Product SKU foar fakturearring direkt op. De header hat foarrang boppe de query en wurdt benammen brûkt foar audio- en voice-rûtes. | Is nedich foar voice-rûtes. audio/speech en audio/transcriptions kieze it Product mei model yn it lichem. |
| anthropic-version / anthropic-beta | Wurdt yn Anthropic-kompatibele rûtes ûnferoare trochjûn. | De ferzje is 2023-06-01. |
Autentikaasje mislearre
As der gjin kaai is of as jo in ferrûne of ynlutsen kaai stjoere, is de status 401. As jo yn in OpenAI-kompatibele rûte sûnder kaai in oprop dogge, krije jo de ûndersteande lichemynhâld, en yn in Anthropic-kompatibele rûte is error.type authentication_error.
{
"error": {
"message": "API key is required.",
"type": "invalid_request_error"
}
}- Kontrolearje de status fan de kaai op it API-kaaiskerm. Freegje in nije oan as de kaai ferrûn of ynlutsen is.
- Kontrolearje oft de headernamme X-API-Key of Authorization is.
- As jo Authorization brûke yn in OpenAI-kompatibele rûte, kontrolearje dan it foarheaksel Bearer.