Developer guide
API ачкычы менен аутентификациядан өтүү
API ачкычын камтыган баш жана SDK'де коюлуучу base URL
Бул бетте CLEVI шлюзунда API ачкычы менен аутентификациядан өтүү жолдору каралат.
OpenAI'ге шайкеш жолдо да, Anthropic'ке шайкеш жолдо да бир ачкыч менен аутентификациядан өтөсүз,
бирок ачкыч коюлуучу баштын уруксат берилген диапазону жана SDK'де коюлуучу base URL спецификацияга жараша айырмаланат.
Аутентификация башы
Эки шайкеш спецификацияда тең бир API ачкычы менен аутентификациядан өтөсүз. Ачкыч консолдогу API ачкычтары бөлүмүнөн түзүлөт, ал эле жерден аны жокко чыгарып, колдонуу чөйрөсүн башкарасыз.
| Баш | OpenAI'ге шайкеш | Anthropic'ке шайкеш |
|---|---|---|
| X-API-Key: <ачкыч> | Колдонууга болот | Колдонууга болот |
| Authorization: Bearer <ачкыч> | Колдонууга болот | Колдонууга болот |
| Authorization: <ачкыч> (Bearer'сиз) | Четке кагылат | Колдонууга болот |
Баштын аталыштарында чоң-кичине тамгалар айырмаланбайт. Anthropic SDK жөнөткөн x-api-key да өзгөртүүсүз иштейт.
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 (суроодо product_sku катары да колдонсо болот) | Эсептешүү үчүн колдонула турган Product SKU'ну түз көрсөтөт. Баш сабы суроодон артыкчылыктуу болуп, негизинен үн·voice жолдорунда колдонулат. | Voice жолдорунда керек. audio/speech жана audio/transcriptions үчүн Product негизги бөлүктөгү model аркылуу тандалат. |
| anthropic-version / anthropic-beta | Anthropic менен шайкеш жолдо өзгөртүүсүз өткөрүлөт. | Версиясы 2023-06-01. |
Аутентификация ишке ашкан жок
Ачкыч жок болсо же мөөнөтү бүткөн·жокко чыгарылган ачкыч жөнөтүлсө, 401 кайтарылат. OpenAI менен шайкеш жолдо ачкычсыз чалуу жасалса, төмөнкү негизги бөлүк кайтарылат, ал эми Anthropic менен шайкеш жолдогу error.type мааниси authentication_error болот.
{
"error": {
"message": "API key is required.",
"type": "invalid_request_error"
}
}- API ачкычтарынын экранынан ачкычтын абалын текшериңиз. Мөөнөтү бүткөн же жокко чыгарылган болсо, жаңысын чыгарыңыз.
- Баш сабынын аталышы X-API-Key же Authorization экенин текшериңиз.
- OpenAI менен шайкеш жолдо Authorization колдонсоңуз, Bearer префиксин текшериңиз.