Developer guide
Furtuu API tiin mirkaneessuu
Mata-duree furtuu API itti galchuu fi base URL SDK keessatti qindeessuu
Fuulli kun akkamitti gateway CLEVI irratti furtuu API tiin mirkanaa'an ilaala.
Daandii OpenAI waliin walsimu fi daandii Anthropic waliin walsimu lamaan isaanii furtuu tokkoon mirkaneessu;
daangaan hayyamamaa mata-duree furtuu itti galchuu fi base URL SDK keessatti qindeessuu garuu akka istaandaardii sanaatti garaagara.
Mata-duree mirkaneessaa
Istaandaardota walsimoo lamaan isaanii furtuu API tokkoon mirkaneessu. Furtuun fuula furtuu API kan konsoolii irratti argamu irraa kennama; fuula kana irratti haqamuu fi daangaan itti fayyadamaa to'atama.
| Mata-duree | OpenAI waliin walsimu | Anthropic waliin walsimu |
|---|---|---|
| X-API-Key: <furtuu> | Ni danda'ama | Ni danda'ama |
| Authorization: Bearer <furtuu> | Ni danda'ama | Ni danda'ama |
| Authorization: <furtuu> (Bearer malee) | Ni didama | Ni danda'ama |
Maqaan mata-duree qubee guguddaa fi xixiqqaa hin ilaalu. x-api-key kan Anthropic SDK ergu illee akkuma jirutti hojjeta.
base URL
SDK isin duraan itti fayyadamaa turtan, base URL qofa gara teessoo armaan gadiitti jijjiirtanii akkuma jirutti fayyadamu. Teessoon lamaan /v1 base URL keessatti hammachuu fi dhiisuu isaaniitiin garaagaru.
| Istaandaardii | base URL | Seera daandii |
|---|---|---|
| OpenAI waliin walsimu | https://platform.clevi.net/api/v2/aiservice/openai/v1 | Hanga /v1 base URL keessatti hammachiisi. |
| Anthropic waliin walsimu | https://platform.clevi.net/api/v2/aiservice/anthropic | Anthropic SDK ofii isaatiin daandii irratti /v1 waan dabaluuf, /v1 dura irratti xumurama. |
Mirkaneessa mirkaneessuu
Furtuu fi base URL galchitanii tarree moodeelotaa yoo gaafattan, mirkaneessamuun isaa battalum ni beekama. Kanneen armaan gadii sadii gaafannoo walfakkaataa curl, OpenAI SDK fi Anthropic SDK tiin raawwatu.
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)Iddoo sk-... jedhu irratti furtuu fuula furtuu API irraa kennamtetti galchi.
- Yoo deebiin 200 ta'e, mirkaneessamuun milkaa'eera. data keessatti tarreen moodeelota furtuu kanaan waamamuu danda'an jira.
- Yoo deebiin 401 ta'e, tartiiba kutaa mirkaneessuun fashalaa'e armaan gadiitiin mirkaneessi.
Mata-duree waliin fayyadaman
Hundumtuu filannoo qofa. Rakkoo hordofuuf X-Request-Id galchuun gaarii dha.
| Mata-duree | Kaayyoo | Yoo dhiifame |
|---|---|---|
| X-Request-Id | Eenyummaa gaaffii hordofuuf. Deebii Anthropic wajjin walsimu keessatti akka mata-duree request-id ti deebi'a. | Sarvariin kenna. |
| X-Region-Code | Naannoo waamicha | global dha. |
| X-Product-Sku (akkasumas product_sku jedhuun query keessatti ni danda'ama) | Product SKU kaffaltiif itti fayyadamu kallattiin murteessa. Mata-dureen query caalaatti dursa; irra caalaa daandiiwwan sagalee fi voice irratti fayyadama. | Daandii voice irratti barbaachisaa dha. audio/speech fi audio/transcriptions keessatti Product qaama model tiin filadhu. |
| anthropic-version / anthropic-beta | Daandii Anthropic wajjin walsimu keessatti akkuma jirutti dabarfama. | Version isaa 2023-06-01 dha. |
Mirkaneessuun hin milkoofne
Yoo furtuu hin jirre ykn furtuu dhumate yookaan haqame ergite, 401 dha. Daandii OpenAI wajjin walsimu keessatti furtuu malee yoo waamicha goote, qaamni armaan gadii ni dhufa; daandii Anthropic wajjin walsimu keessatti error.type authentication_error dha.
{
"error": {
"message": "API key is required.",
"type": "invalid_request_error"
}
}- Fuula furtuu API irratti haala furtuu ilaali. Yoo furtuun dhumate ykn haqame, haaraa baasi.
- Maqaan mata-duree X-API-Key ykn Authorization ta'uu isaa mirkaneessi.
- Daandii OpenAI wajjin walsimu keessatti Authorization yoo fayyadamte, durfama Bearer jiru isaa mirkaneessi.