Mengesahkan dengan kunci API

Halaman ini menerangkan cara mengesahkan dengan kunci API di gerbang CLEVI.
Kedua-dua laluan yang serasi dengan OpenAI dan yang serasi dengan Anthropic menggunakan satu kunci untuk pengesahan,
dan julat header yang boleh digunakan untuk memasukkan kunci serta base URL untuk dikonfigurasikan dalam SDK berbeza mengikut spesifikasi.

Header pengesahan

Kedua-dua spesifikasi yang serasi menggunakan satu kunci API untuk pengesahan. Kunci dikeluarkan pada skrin kunci API dalam konsol, dan pembatalan serta skop penggunaan boleh diurus pada skrin yang sama.

Nama header tidak membezakan huruf besar dan kecil. x-api-key yang dihantar oleh Anthropic SDK juga berfungsi seperti biasa.

base URL

SDK yang anda gunakan boleh terus digunakan dengan hanya menukar base URL kepada alamat di bawah. Perbezaan antara kedua-dua alamat ialah sama ada ia mengandungi /v1 atau tidak.

Mengesahkan pengesahan

Anda boleh mengetahui dengan segera sama ada pengesahan berjaya dengan memasukkan kunci dan base URL, kemudian mendapatkan senarai model. Ketiga-tiga contoh di bawah melakukan carian yang sama menggunakan curl, OpenAI SDK dan 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)

Gantikan skk-... dengan kunci yang dikeluarkan pada skrin kunci API.

• Jika respons ialah 200, pengesahan berjaya. data mengandungi senarai model yang boleh dipanggil dengan kunci ini.
• Jika respons ialah 401, semak mengikut urutan dalam bahagian Kegagalan pengesahan di bawah.

Header yang digunakan bersama

Semuanya adalah pilihan. Untuk menjejaki masalah, sebaiknya sertakan X-Request-Id.

Kegagalan pengesahan

Jika tiada kunci dihantar atau kunci yang luput·dibatalkan dihantar, responsnya ialah 401. Jika anda membuat panggilan tanpa kunci pada laluan yang serasi dengan OpenAI, badan di bawah akan diterima, manakala error.type pada laluan yang serasi dengan Anthropic ialah authentication_error.

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

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