Sahkan dengan kunci API

Gerbang CLEVI mengesahkan laluan yang serasi dengan OpenAI dan laluan yang serasi dengan Anthropic menggunakan satu kunci API.
Terdapat dua nilai yang perlu dikonfigurasikan pada klien: pengepala pengesahan yang mengandungi kunci dan base URL SDK. Format pengepala serta base URL yang dibenarkan berbeza mengikut spesifikasi.
Selepas konfigurasi selesai, anda boleh menyemak status pengesahan dengan segera dengan mendapatkan senarai model.
Jika pengesahan gagal, 401 akan dikembalikan. Jika pengesahan berjaya tetapi syarat kebenaran atau had tidak dipenuhi, 403 akan dikembalikan.

Keluarkan kunci API pada skrin kunci API dalam konsol. Pada skrin yang sama, anda boleh mengurus pembatalan kunci dan skop penggunaannya.

Pengepala pengesahan

Kedua-dua spesifikasi membawa kunci API dalam satu pengepala permintaan. Gunakan sama ada pengepala X-API-Key atau pengepala Authorization. Format yang dibenarkan berbeza mengikut spesifikasi.

Apabila menggunakan pengepala Authorization pada laluan yang serasi dengan OpenAI, awalan Bearer diperlukan. Jika hanya kunci dihantar tanpa awalan tersebut, gerbang akan menolak permintaan.

Nama pengepala tidak peka huruf besar-kecil, jadi pengepala x-api-key yang dihantar oleh Anthropic SDK juga berfungsi seperti biasa. Jika kedua-dua pengepala ditetapkan, nilai X-API-Key akan diberi keutamaan.

base URL

SDK yang telah anda gunakan sebelum ini boleh terus digunakan dengan hanya menukar base URL kepada alamat di bawah. Kedua-dua alamat berbeza dari segi sama ada /v1 disertakan atau tidak, jadi tetapkan alamat yang sepadan dengan spesifikasi tanpa mengubahnya.

Semak pengesahan

Selepas menetapkan kunci dan URL asas, anda boleh menyemak status pengesahan dengan mendapatkan senarai model. Contoh di bawah menjalankan permintaan yang sama menggunakan curl, OpenAI SDK dan Anthropic SDK. Gantikan sk-... dengan kunci yang dikeluarkan pada skrin kunci API.

Apabila membuat permintaan menggunakan curl, tentukan laluan penuh hingga /v1/models untuk kedua-dua spesifikasi. Perintah pertama menggunakan pengepala X-API-Key pada laluan yang serasi dengan OpenAI, manakala perintah kedua menggunakan pengepala Authorization pada laluan yang serasi dengan 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"

Untuk OpenAI SDK, tentukan alamat yang merangkumi /v1 dalam 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)

Untuk Anthropic SDK, tentukan alamat base_url yang berakhir sebelum /v1.
Untuk pengesahan, gunakan pengepala x-api-key yang dihantar oleh SDK tanpa perubahan.

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)

Jika respons bagi mana-mana contoh ialah 200, pengesahan berjaya dan data dalam respons mengandungi senarai model yang boleh dipanggil menggunakan kunci ini. Jika respons ialah 401, semak puncanya mengikut turutan dalam bahagian seterusnya.

Pengesahan gagal

Jika anda menghantar kunci yang tiada, telah tamat tempoh atau telah dibatalkan, responsnya ialah 401. Apabila membuat permintaan tanpa kunci pada laluan yang serasi dengan OpenAI, isi di bawah dikembalikan, manakala pada laluan yang serasi dengan Anthropic, error.type ialah authentication_error.

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

Jika menerima 401, semak mengikut turutan berikut.

1. Semak status kunci pada skrin kunci API. Jika kunci telah tamat tempoh atau dibatalkan, keluarkan kunci baharu.
2. Semak sama ada nama pengepala ialah X-API-Key atau Authorization.
3. Jika menggunakan pengepala Authorization pada laluan yang serasi dengan OpenAI, semak sama ada awalan Bearer ada.

Selepas membuat pembetulan, jalankan semula permintaan senarai model dalam bahagian pengesahan untuk memastikan respons yang diterima ialah 200.

Pengepala yang digunakan bersama

Semua pengepala berikut adalah pilihan. Kami mengesyorkan agar X-Request-Id ditetapkan supaya masalah dapat dijejaki.

Jika 5xx berlaku berulang kali, maklumkan kepada kami melalui bantuan dan pertanyaan bersama X-Request-Id. Jika nilai ditentukan secara langsung, ia boleh dibandingkan terus dengan rekod klien.