Developer guide
Furtuu API’n mirkaneessuu
Mata-duree furtuu API itti galchuu fi base URL SDK keessatti qindeessuu
Gateway’n CLEVI daandiiwwan OpenAI waliin walsiman fi Anthropic waliin walsiman furtuu API tokkoon mirkaneessa.
Gatiiwwan maamilaa irratti qindeessan lama: mata-duree mirkaneessaa furtuu qabatuu fi base URL SDK ti; bifa mata-duree fi base URL hayyamaman akka istaandaardiiwwanitti garaagara.
Erga qindeessitanii booda, tarreewwan moodeelotaa gaafachuun mirkaneessichi jiraachuu isaa battalumatti mirkaneessuu dandeessu.
Yoo mirkaneessuun hin milkoofne 401, yoo mirkaneessuun milkaa'ee garuu ulaagaalee hayyamaa ykn daangaa hin guutne 403 deebisa.
Furtuu API fuula furtuu API kan konsoolii irraa baasaa. Fuulauma sana irratti furtuu haquu fi daangaa itti fayyadamaa isaa to'achuu dandeessu.
Mata-duree mirkaneessaa
Istaandaardoonni lamaan iyyata mata-duree tokko keessatti furtuu API qabsiisu. Mata-duree X-API-Key ykn Authorization keessaa tokko fayyadami; bifa hayyamamu istaandaardii irratti hundaa'a.
| Mata-duree | OpenAI waliin walsimu | Anthropic waliin walsimu |
|---|---|---|
| X-API-Key: <키> | Kan itti fayyadamu danda'amu | Kan itti fayyadamu danda'amu |
| Authorization: Bearer <키> | Kan itti fayyadamu danda'amu | Kan itti fayyadamu danda'amu |
| Authorization: <키> (Bearer malee) | Ni didama | Kan itti fayyadamu danda'amu |
Yeroo daandii OpenAI waliin walsimu keessatti mata-duree Authorization fayyadamtan, durduubaan Bearer barbaachisa. Yoo furtuu qofa, durduubaa malee ergitan, gateway’n iyyata ni dide.
Maqaan mata-duree qubee guddaa fi xinnaa hin addaan baasu; kanaaf mata-dureen x-api-key kan Anthropic SDK ergu illee akkuma jirutti hojjeta. Yoo mata-dureewwan lamaan isaanii qindeessitan, gatiin X-API-Key dursa hojiirra oola.
base URL
SDK duraan itti fayyadamaa turtan, base URL qofa gara teessoo armaan gadiitti jijjiirtanii akkuma jirutti fayyadamuu dandeessu. Teessowwan lamaan /v1 of keessatti qabachuu fi dhabuu qofaan garaagarummaa qabu; teessoo istaandaardii wajjin walsimu akkuma jirutti qindeessaa.
| Istaandaardii | base URL | Seera daandii |
|---|---|---|
| OpenAI waliin walsimu | https://platform.clevi.net/api/v2/aiservice/openai/v1 | Hanga /v1 base URL keessatti dabali. |
| Anthropic waliin walsimu | https://platform.clevi.net/api/v2/aiservice/anthropic | Anthropic SDK daandii iyyataa keessatti /v1 kallattiin dabala; kanaaf /v1 dura xumurama. |
Mirkaneessa mirkaneessuu
Furtuu fi base URL erga qindeessitanii booda, tarree moodeelotaa gaafachuun mirkaneessi argamuu isaa ilaaluu dandeessu. Fakkeenyi armaan gadii gaafannoo walfakkaataa curl, OpenAI SDK fi Anthropic SDK fayyadamuun raawwata. Bakka sk-...tti furtuu fuula furtuu API irraa argattan galchaa.
Yeroo curl fayyadamtan, ulaagaalee lamaan keessatti karaa guutuu hanga /v1/models tti ifatti kaa'aa. Ajajni jalqabaa karaa OpenAI waliin walsimu keessatti mataduree X-API-Key, ajajni lammaffaan immoo karaa Anthropic waliin walsimu keessatti mataduree Authorization fayyadama.
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 keessatti, teessoo /v1 of keessaa qabu base_url irratti kaa'aa.
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 keessatti, base_url teessoo /v1 dura xumuramu irratti kaa'aa.
Mirkaneessaaf mataduree x-api-key SDK'n ergame akkuma jirutti fayyadamaa.
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)Fakkeenya kamiyyuu keessatti deebiin 200 yoo ta'e, mirkaneessi milkaa'eera; data deebii keessatti tarreen moodeelotaa furtuu kanaan waamamuu danda'an jira. Yoo 401 ta'e, sababaa isaa tartiiba kutaa itti aanu keessatti ibsameen mirkaneessaa.
Mirkaneessuun hin milkoofne
Yoo furtuu hin jirre ykn furtuu yeroon isaa darbe ykn haqame ergitan, 401 deebisa. Karaa OpenAI waliin walsimu keessatti furtuu malee yoo waamamtan, qaamni armaan gadii deebifama; karaa Anthropic waliin walsimu keessatti immoo error.type authentication_error dha.
{
"error": {
"message": "API key is required.",
"type": "invalid_request_error"
}
}Yoo 401 argattan, tartiiba armaan gadiitiin mirkaneessaa.
- Fuula furtuu API irratti haala furtuu ilaalaa. Yoo yeroon isaa darbe ykn haqame ta'e, haaraa baasaa.
- Maqaan mataduree X-API-Key ykn Authorization ta'uu isaa mirkaneessaa.
- Karaa OpenAI waliin walsimu keessatti mataduree Authorization yoo fayyadamtan, duratti jedhuun Bearer jiraachuu isaa mirkaneessaa.
Erga sirreessitanii booda, kutaa mirkaneessa keessatti gaafannoo tarree moodeelotaa irra deebi'aa; 200 dhufuu isaa mirkaneessaa.
Matadureewwan waliin fayyadaman
Matadureewwan armaan gadii hundi filannoowwanidha. Rakkoo hordofuuf X-Request-Id murteessuun ni gorfama.
| Mataduree | Kaayyoo | Yoo dhiifame |
|---|---|---|
| X-Request-Id | እየተጠየቀ ያለውን ጥያቄ ለመከታተል የሚያገለግል መለያ ነው። የAnthropic ተኳሃኝ መንገድ በምላሹ የrequest-id ራስጌ ተመሳሳይ ዋጋ ይመልሳል። | ሰርቨሩ ይመድበዋል። |
| X-Region-Code | የጥሪ ክልሉን ይገልጻል። | global ነው። |
| X-Product-Sku (በጥያቄው product_sku በመጠቀምም ሊገለጽ ይችላል) | ለክፍያ የሚውለውን Product SKU በቀጥታ ይገልጻል። ራስጌው ከጥያቄው ይቀድማል፤ በአብዛኛው በድምጽ·voice መንገዶች ይጠቀማል። | በvoice መንገድ መተው አይቻልም። audio/speech እና audio/transcriptions ከጥያቄው አካል ውስጥ ባለው model Product ይመርጣሉ። |
| anthropic-version / anthropic-beta | በAnthropic ተኳሃኝ መንገድ እንዳለ ያስተላልፋል። | ስሪቱ 2023-06-01 ነው። |
5xx በተደጋጋሚ ከተከሰተ፣ እባክዎ ከX-Request-Id ጋር በእገዛ ገጹ እና በጥያቄ መንገዱ ያሳውቁን። ዋጋውን እርስዎ በቀጥታ ካስገቡት፣ ከደንበኛው መዝገብ ጋር ወዲያውኑ ማነጻጸር ይችላሉ።