Developer guide
Автентикација со API клуч
Заглавјето во кое се внесува API клучот и base URL што треба да се постави во SDK
Оваа страница објаснува како да се автентицирате со API клуч во CLEVI гејтвејот.
И кај OpenAI компатибилната патека и кај Anthropic компатибилната патека, автентикацијата се врши со еден клуч,
но дозволеното заглавје во кое се внесува клучот и base URL што треба да се постави во SDK се разликуваат според спецификацијата.
Заглавје за автентикација
И двете компатибилни спецификации се автентицираат со еден API клуч. Клучот се издава на екранот за API клучеви во конзолата, а на истиот екран се управува со неговото отповикување и опсегот на употреба.
| Заглавје | OpenAI компатибилно | Anthropic компатибилно |
|---|---|---|
| X-API-Key: <клуч> | Дозволено | Дозволено |
| Authorization: Bearer <клуч> | Дозволено | Дозволено |
| Authorization: <клуч> (без Bearer) | Одбиено | Дозволено |
Името на заглавјето не зависи од големи и мали букви. x-api-key што го испраќа Anthropic SDK исто така функционира без промени.
base URL
SDK што веќе го користите ќе продолжи да работи ако само го промените base URL на адресата подолу. Двете адреси се разликуваат по тоа дали вклучуваат /v1.
| Спецификација | base URL | Правило за патеката |
|---|---|---|
| OpenAI компатибилно | https://platform.clevi.net/api/v2/aiservice/openai/v1 | Вклучете го до /v1 во base URL. |
| Anthropic компатибилно | https://platform.clevi.net/api/v2/aiservice/anthropic | Anthropic SDK автоматски додава /v1 во патеката, па завршува пред /v1. |
Проверка на автентикацијата
Автентикацијата можете веднаш да ја проверите ако ги внесете клучот и base URL и го побарате списокот на модели. Подолу истото барање се извршува со curl, OpenAI SDK и 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)На местото sk-... внесете го клучот издаден на екранот за API клучеви.
- Ако одговорот е 200, автентикацијата е успешна. Во data е содржан списокот на модели што може да се повикаат со овој клуч.
- Ако одговорот е 401, проверете по редоследот во делот за неуспешна автентикација подолу.
Заглавја што се користат заедно
Сите се опционални. За следење на проблемите, се препорачува да го вклучите X-Request-Id.
| Заглавие | Намена | Ако се изостави |
|---|---|---|
| X-Request-Id | Идентификатор за следење на барањето. Во одговорите компатибилни со Anthropic се враќа како заглавие request-id. | Го издава серверот. |
| X-Region-Code | Регион за повикување | Тоа е global. |
| X-Product-Sku (достапно и преку query product_sku) | Директно го одредува Product SKU што ќе се користи за наплата. Заглавието има предност пред query-параметарот и главно се користи кај audio/voice патеките. | Потребно е кај voice патеките. Кај audio/speech и audio/transcriptions, Product се избира со model во телото на барањето. |
| anthropic-version / anthropic-beta | Се проследува непроменето кај патеките компатибилни со Anthropic. | Верзијата е 2023-06-01. |
Неуспешна автентикација
Ако не испратите клуч или испратите истечен или укинат клуч, ќе добиете 401. При повикување без клуч преку патека компатибилна со OpenAI, ќе го добиете телото подолу, а error.type кај патеката компатибилна со Anthropic е authentication_error.
{
"error": {
"message": "API key is required.",
"type": "invalid_request_error"
}
}- Проверете го статусот на клучот на екранот за API клучеви. Ако е истечен или укинат, издајте нов.
- Проверете дали името на заглавието е X-API-Key или Authorization.
- Ако користите Authorization кај патека компатибилна со OpenAI, проверете го префиксот Bearer.