Developer guide
Kutsimikizira pogwiritsa ntchito kiyi ya API
Header yomwe muyikemo kiyi ya API ndi base URL yoti muyike mu SDK
Tsambali likufotokoza momwe mungatsimikizire ndi kiyi ya API pa CLEVI gateway.
Njira zonse za OpenAI-compatible ndi Anthropic-compatible zimatsimikizira pogwiritsa ntchito kiyi imodzi,
koma malire ovomerezeka a header yomwe imakhala ndi kiyi ndi base URL yoti muyike mu SDK zimasiyana malinga ndi muyezo.
Header yotsimikizira
Miyezo yonse iwiri yogwirizana imatsimikizira pogwiritsa ntchito kiyi imodzi ya API. Kiyi imaperekedwa patsamba la API keys mu console, ndipo kuchotsa ndi kuyang'anira momwe imagwiritsidwira ntchito kumachitikanso patsamba lomwelo.
| Header | OpenAI-compatible | Anthropic-compatible |
|---|---|---|
| X-API-Key: <키> | Yololedwa | Yololedwa |
| Authorization: Bearer <키> | Yololedwa | Yololedwa |
| Authorization: <키> (popanda Bearer) | Yakanidwa | Yololedwa |
Mayina a ma header sasiyanitsa zilembo zazikulu ndi zazing'ono. x-api-key yomwe Anthropic SDK imatumiza imagwiranso ntchito monga ilili.
base URL
SDK yomwe mumagwiritsa ntchito kale idzagwira ntchito mutangosintha base URL kukhala adilesi ili pansipa. Ma adilesi awiriwa amasiyana pa ngati akuphatikiza /v1 kapena ayi.
| Muyezo | base URL | Malamulo a njira |
|---|---|---|
| OpenAI-compatible | https://platform.clevi.net/api/v2/aiservice/openai/v1 | Phatikizani mpaka /v1 mu base URL. |
| Anthropic-compatible | https://platform.clevi.net/api/v2/aiservice/anthropic | Anthropic SDK imawonjezera /v1 yokha mu njira, choncho base URL imathera isanayambe /v1. |
Kutsimikizira kutsimikiziridwa
Mutha kudziwa nthawi yomweyo ngati kutsimikizira kwachitika mwa kuika kiyi ndi base URL kenako kufunsa mndandanda wa ma model. Zitsanzo zitatu pansizi zimachita funso lomwelo pogwiritsa ntchito curl, OpenAI SDK, ndi 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)Pa malo a sk-... ikani kiyi yomwe mwalandira patsamba la API keys.
- Ngati yankho lili 200, kutsimikizira kwachitika. data ili ndi mndandanda wa ma model omwe angayitanidwe pogwiritsa ntchito kiyi iyi.
- Ngati yankho lili 401, yang'anani motsatira dongosolo la gawo la kulephera kwa kutsimikizira pansipa.
Ma header ogwiritsidwa ntchito limodzi
Zonsezi ndizosankha. Kuti muzitsatira vuto, ndi bwino kuika X-Request-Id.
| Mutu | Ntchito | Ngati wasiya |
|---|---|---|
| X-Request-Id | Chizindikiritso chotsatira pempho. Mu mayankho ogwirizana ndi Anthropic, chimabwezedwa ngati mutu wa request-id. | Seva imapereka. |
| X-Region-Code | Dera limene kuyitanako kwachokera | Ndi global. |
| X-Product-Sku (ikhozanso kugwiritsidwa ntchito ngati query product_sku) | Imatchula mwachindunji Product SKU yomwe idzagwiritsidwe ntchito polipiritsa. Mutu umakhala patsogolo pa query, ndipo umagwiritsidwa ntchito makamaka pa njira za mawu ndi voice. | Ndikofunikira pa njira za voice. audio/speech ndi audio/transcriptions amasankha Product pogwiritsa ntchito model yomwe ili m’thupi. |
| anthropic-version / anthropic-beta | Zimatumizidwa momwemo pa njira yogwirizana ndi Anthropic. | Mtunduwu ndi 2023-06-01. |
Kulephera kutsimikizira
Ngati mutumiza kiyi yomwe ikusowa, yatha ntchito, kapena yathetsedwa, mudzalandira 401. Mukayitana njira yogwirizana ndi OpenAI popanda kiyi, mudzalandira thupi ili pansipa, ndipo error.type pa njira yogwirizana ndi Anthropic ndi authentication_error.
{
"error": {
"message": "API key is required.",
"type": "invalid_request_error"
}
}- Yang'anani momwe kiyi ilili patsamba la ma API key. Ngati yatha ntchito kapena yathetsedwa, pangani yatsopano.
- Tsimikizirani ngati dzina la mutu ndi X-API-Key kapena Authorization.
- Ngati mugwiritsa ntchito Authorization pa njira yogwirizana ndi OpenAI, tsimikizirani mawu oyamba a Bearer.