Developer guide
Bi mifteya API-yê rastkirin
Sernavê ku tê de mifteya API-yê tê xistin û base URL ku di SDK-yê de tê sazkirin
Ev rûpel rêbaza rastkirina bi mifteya API-yê li deriyê CLEVI rave dike.
Hem rêça hevahenga OpenAI û hem jî rêça hevahenga Anthropic bi yek mifteyê rast dikin,
qada destûrê ya sernavê ku mifte tê de tê xistin û base URL-a ku di SDK-yê de tê sazkirin li gorî her standardê cuda ye.
Sernavê rastkirinê
Her du standardên hevaheng bi yek mifteya API-yê rast dikin. Mifte ji rûpela Mifteyên API-yê ya konsolê tê derxistin, û ji heman rûpelê ve betalkirin û qada bikaranînê têne rêvebirin.
| Sernav | Hevahenga OpenAI | Hevahenga Anthropic |
|---|---|---|
| X-API-Key: <키> | Tê bikaranîn | Tê bikaranîn |
| Authorization: Bearer <키> | Tê bikaranîn | Tê bikaranîn |
| Authorization: <키> (Bê Bearer) | Tê redkirin | Tê bikaranîn |
Navê sernavê ji tîpên mezin û biçûk re hestiyar nîn e. x-api-key ya ku ji hêla SDK-ya Anthropic ve tê şandin jî rasterast dixebite.
base URL
SDK-ya ku we bi kar dianî, tenê base URL biguhezîne bo navnîşana jêrîn û wê wekî berê bi kar bîne. Di navbera her du navnîşanan de cudahiya hebûna /v1 heye.
| Standard | base URL | Rêgeza rêçê |
|---|---|---|
| Hevahenga OpenAI | https://platform.clevi.net/api/v2/aiservice/openai/v1 | base URL heta /v1 dihewîne. |
| Hevahenga Anthropic | https://platform.clevi.net/api/v2/aiservice/anthropic | Ji ber ku SDK-ya Anthropic /v1 bi xwe li rêçê zêde dike, li ber /v1 diqede. |
Kontrolkirina rastkirinê
Dema ku hûn mifte û base URL têxin û lîsteya modelan bixwînin, hûn dikarin bilez bizanin ka rastkirin çêbûye an na. Van sê rêbazan heman daxwazê bi curl, OpenAI SDK û Anthropic SDK dikin.
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)Li şûna sk-... mifteya ku ji rûpela Mifteyên API-yê hatiye derxistin, binivîsin.
- Ger bersiv 200 be, rastkirin çêbûye. Di data de lîsteya modelên ku dikarin bi vê mifteyê werin gazîkirin heye.
- Ger bersiv 401 be, li gorî rêza beşa têkçûna rastkirinê ya jêrîn kontrol bikin.
Sernavê hevkar
Hemû ji bo hilbijartinê ne. Ji bo şopandina pirsgirêkan, baştir e X-Request-Id têxî.
| Sernav | Armanc | Heke were berdan |
|---|---|---|
| X-Request-Id | Nasnameya ji bo şopandina daxwazê. Di bersivên ku bi Anthropic re lihevhatî ne, wekî sernavê request-id vedigere. | Ji aliyê serverê ve tê dayîn. |
| X-Region-Code | Herêma bangkirinê | global e. |
| X-Product-Sku (bi query product_sku jî gengaz e) | Product SKU ya ku dê ji bo billingê were bikaranîn, rasterast destnîşan dike. Sernav li hemberî query pêşî tê, û bi girîngî di rêyên deng û voice de tê bikaranîn. | Di rêyên voice de pêwîst e. audio/speech û audio/transcriptions Productê bi modela di navbûyînê de hilbijêrin. |
| anthropic-version / anthropic-beta | Di rêyên ku bi Anthropic re lihevhatî ne, wekî xwe têne şandin. | Versiyon 2023-06-01 e. |
Bêserûberiya rastandinê
Heke tu bê kilît an kilîteke demê wê qediya an jêbirî şînî, 401 e. Heke di rêya ku bi OpenAI re lihevhatî ye bê kilît bang bikî, ev navarok tê, û di rêya ku bi Anthropic re lihevhatî ye, error.type authentication_error e.
{
"error": {
"message": "API key is required.",
"type": "invalid_request_error"
}
}- Di rûpela kilîtên API de rewşa kilîtê kontrol bikin. Heke kilît demê wê qediya an hatiye jêbirin, kilîteke nû derxînin.
- Kontrol bikin ka navê sernavê X-API-Key e an Authorization.
- Heke di rêya ku bi OpenAI re lihevhatî ye Authorization bi kar tînin, pêşgira Bearer kontrol bikin.