Developer guide
Otentikasi nganggo kunci API
Header kanggo nyelehake kunci API lan base URL kanggo disetel ing SDK
Kaca iki nerangake cara otentikasi menyang gateway CLEVI nganggo kunci API.
Path sing kompatibel karo OpenAI lan path sing kompatibel karo Anthropic padha nggunakake siji kunci kanggo otentikasi,
nanging cakupan header kanggo nyelehake kunci lan base URL sing disetel ing SDK beda-beda miturut spesifikasi.
Header otentikasi
Kaloro spesifikasi kompatibel padha nggunakake siji kunci API kanggo otentikasi. Kunci diterbitake saka layar kunci API ing konsol, lan ing layar sing padha sampeyan bisa ngatur pencabutan lan cakupan panggunaan.
| Header | Kompatibel karo OpenAI | Kompatibel karo Anthropic |
|---|---|---|
| X-API-Key: <키> | Bisa digunakake | Bisa digunakake |
| Authorization: Bearer <키> | Bisa digunakake | Bisa digunakake |
| Authorization: <키> (tanpa Bearer) | Ditolak | Bisa digunakake |
Jeneng header ora mbedakake huruf gedhé lan cilik. x-api-key sing dikirim dening Anthropic SDK uga bisa digunakake langsung.
base URL
SDK sing wis digunakake bisa langsung tetep digunakake kanthi mung ngganti base URL menyang alamat ing ngisor iki. Kaloro alamat iki beda ing bab kalebu utawa ora kalebu /v1.
| Spesifikasi | base URL | Aturan path |
|---|---|---|
| Kompatibel karo OpenAI | https://platform.clevi.net/api/v2/aiservice/openai/v1 | Kalebu nganti /v1 ing base URL. |
| Kompatibel karo Anthropic | https://platform.clevi.net/api/v2/aiservice/anthropic | Amarga Anthropic SDK nambahake /v1 menyang path kanthi otomatis, base URL rampung sadurunge /v1. |
Mriksa otentikasi
Kanthi nglebokake kunci lan base URL banjur njaluk dhaptar model, sampeyan bisa langsung ngerti apa otentikasi wis kasil. Telung cara ing ngisor iki nindakake panyuwunan sing padha nganggo curl, OpenAI SDK, lan 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)Ing panggonan sk-... lebokake kunci sing diterbitake saka layar kunci API.
- Yen responsé 200, tegese otentikasi wis kasil. data ngemot dhaptar model sing bisa digunakake kanggo panggilan nganggo kunci iki.
- Yen responsé 401, priksa miturut urutan ing bagean kegagalan otentikasi ing ngisor iki.
Header sing digunakake bebarengan
Kabeh iku opsional. Kanggo nglacak masalah, luwih becik X-Request-Id dilebokake.
| Header | Panggunaan | Yen ora dilebokake |
|---|---|---|
| X-Request-Id | Pengenal kanggo nglacak panjalukan. Ing respons sing kompatibel karo Anthropic, bakal dibalekake minangka header request-id. | Diterbitake dening server. |
| X-Region-Code | Region panggilan | Yaiku global. |
| X-Product-Sku (uga bisa nganggo product_sku ing query) | Nemtokake langsung Product SKU sing bakal digunakake kanggo tagihan. Header nduweni prioritas tinimbang query lan umume digunakake ing jalur audio·swara. | Dibutuhake ing jalur swara. audio/speech lan audio/transcriptions milih Product liwat model ing awak panjalukan. |
| anthropic-version / anthropic-beta | Diterusake apa anane ing jalur sing kompatibel karo Anthropic. | Versine yaiku 2023-06-01. |
Gagal autentikasi
Yen kunci ora ana utawa ngirim kunci sing wis kadaluwarsa·dicabut, asilé 401. Yen nelpon tanpa kunci ing jalur sing kompatibel karo OpenAI, awak panjalukan ing ngisor iki bakal ditampa, lan error.type ing jalur sing kompatibel karo Anthropic yaiku authentication_error.
{
"error": {
"message": "API key is required.",
"type": "invalid_request_error"
}
}- Priksa status kunci ing layar kunci API. Yen kunci wis kadaluwarsa·dicabut, terbitake kunci anyar.
- Priksa manawa jeneng header yaiku X-API-Key utawa Authorization.
- Yen nggunakake Authorization ing jalur sing kompatibel karo OpenAI, priksa prefiks Bearer.