Autentikasi nganggo kunci API

Gateway CLEVI ngautentikasi jalur sing kompatibel karo OpenAI lan jalur sing kompatibel karo Anthropic nganggo siji kunci API.
Nilai sing kudu disetel ing klien ana loro, yaiku header autentikasi sing ngemot kunci lan base URL SDK. Format header lan base URL sing diidinake beda-beda manut spesifikasine.
Sawise rampung nyetel, sampeyan bisa langsung mriksa status autentikasi kanthi njaluk dhaptar model.
Yen autentikasi gagal, bakal ngasilake 401. Yen autentikasi wis kasil nanging syarat wewenang utawa watesan ora kacukupan, bakal ngasilake 403.

Terbitake kunci API saka kaca kunci API ing konsol. Ing kaca sing padha, sampeyan bisa ngatur pencabutan kunci lan cakupan panggunaane.

Header autentikasi

Loro spesifikasi kasebut padha-padha ngemot kunci API ing siji header panjaluk. Gunakake salah siji saka header X-API-Key utawa Authorization, lan format sing diidinake beda-beda manut spesifikasine.

Nalika nggunakake header Authorization ing jalur sing kompatibel karo OpenAI, prefiks Bearer dibutuhake. Yen mung ngirim kunci tanpa prefiks, gateway bakal nolak panjaluke.

Jeneng header ora mbedakake huruf gedhé lan cilik, mula header x-api-key sing dikirim dening Anthropic SDK uga bisa digunakake langsung. Yen loro header ditemtokake, nilai X-API-Key bakal luwih diutamakake.

base URL

SDK sing wis digunakake sadurunge bisa terus digunakake kanthi mung ngganti base URL menyang alamat ing ngisor iki. Kaloro alamat kasebut beda ing bab apa ngemot /v1 utawa ora, mula tentukake alamat sing cocog karo spesifikasine kanthi persis.

Mriksa autentikasi

Sawisé nyetel kunci lan base URL, sampeyan bisa mriksa status autentikasi kanthi njaluk dhaptar model. Conto ing ngisor iki nglakokaké panjalukan sing padha nganggo curl, OpenAI SDK, lan Anthropic SDK. Ganti sk-... nganggo kunci sing diterbitaké ing layar kunci API.

Nalika njaluk nganggo curl, nemtokaké path lengkap nganti /v1/models kanggo loro spesifikasi kasebut. Préntah kapisan nganggo header X-API-Key ing path sing kompatibel karo OpenAI, dene préntah kapindho nganggo header Authorization ing path sing kompatibel karo Anthropic.

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"

OpenAI SDK nemtokaké alamat sing kalebu /v1 ing base_url.

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)

Anthropic SDK nemtokaké base_url minangka alamat sing rampung sadurungé /v1.
Kanggo autentikasi, gunakaké header x-api-key sing dikirim déning SDK tanpa owah-owahan.

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)

Yen tanggapan saka conto apa waé yaiku 200, autentikasi wis kasil, lan data ing tanggapan ngemot dhaptar model sing bisa ditelpon nganggo kunci iki. Yèn asilé 401, priksa panyebabé miturut urutan ing bagean sabanjuré.

Autentikasi gagal

Yèn ngirim kunci sing ora ana, wis kadaluwarsa, utawa wis dicabut, sistem bakal mbalèkaké 401. Yèn nelpon tanpa kunci ing path sing kompatibel karo OpenAI, isi ing ngisor iki bakal dibalèkaké, dene ing path sing kompatibel karo Anthropic, error.type yaiku authentication_error.

{
  "error": {
    "message": "API key is required.",
    "type": "invalid_request_error"
  }
}

Yèn nampa 401, priksa kanthi urutan ing ngisor iki.

1. Priksa status kunci ing layar kunci API. Yèn kunci wis kadaluwarsa utawa dicabut, terbitaké kunci anyar.
2. Priksa manawa jeneng header yaiku X-API-Key utawa Authorization.
3. Yèn nggunakake header Authorization ing path sing kompatibel karo OpenAI, priksa manawa ana awalan Bearer.

Sawisé ndandani, lakokaké manèh panjalukan dhaptar model ing bagean verifikasi autentikasi kanggo mesthekaké asilé 200.

Header sing digunakaké bebarengan

Kabèh header ing ngisor iki opsional. Kanggo mbantu nelusuri masalah, disaranaké supaya X-Request-Id ditemtokaké.

Yen 5xx kedadeyan bola-bali, kabari liwat pandhuan bantuan lan kontak kanthi nyakup X-Request-Id. Yen sampeyan nemtokake nilai kasebut kanthi langsung, nilai kasebut bisa langsung dicocogake karo cathetan klien.