Developer guide
Gazîkirina API
Rêçikên API-yê yên hevaheng û rêgezên streaming û dengê
Ev rûpel rêçikên ku piştî pejirandina nasnameyê bi rastî têne gazîkirin vedibêje.
Ev rêza navnîşana rêçikên hevaheng ên OpenAI û Anthropic, awayê bersivê dema ku stream di navbera daxwazê de tê vekirin,
û rêgezên tenê ji bo rêçikên deng û voice derbasdar e vedibêje.
ID-yên modelan û gazîkirinên destûrdar ên her modelê li rûpela modelan, û sernavên pejirandina nasnameyê û base URL li rûpela Pejirandina bi kilîda API-yê hene.
Rêçika pêşveçûnê
Her du standardên hevaheng heman kilîda API-yê bi kar tînin, û modelên aqilê diafirînin dikarin bi her du standardan werin gazîkirin. Li gorî armanca we û SDK-ya ku hûn bi kar tînin, rêçikê hilbijêrin.
| Armanc | Standard | Rêçik |
|---|---|---|
| Suydandina interaktîf, bi karanîna OpenAI SDK | Hevahenga OpenAI | POST /chat/completions an POST /responses |
| Suydandina interaktîf, bi karanîna Anthropic SDK | Hevahenga Anthropic | POST /v1/messages |
| Afirandina embedding | Hevahenga OpenAI | POST /embeddings |
| Sentezkirina deng û veguhastina nivîsê, rêveberiya voice | Hevahenga OpenAI | Rêçikên di bin /audio û /voices de |
| Kontrolkirina modelên ku dikarin werin gazîkirin | Her du | GET /models |
Rêçika hevahenga OpenAI
base URL https://platform.clevi.net/api/v2/aiservice/openai/v1 e, û bedenên daxwaz û bersivê li gorî standarda OpenAI ne. Tabloya jêrîn rêçikên suyandina interaktîf û modelan nîşan dide, û rêçikên deng û voice di beşa paşîn de cuda hatine rêzkirin.
| Metod | Rêçik | Danasîn |
|---|---|---|
| POST | /api/v2/aiservice/openai/v1/chat/completions | Mêjandina hevpeyvînê. Ger stream çalak be, bersiv bi SSE tê şandin. |
| POST | /api/v2/aiservice/openai/v1/responses | Bangkirina standarda Responses. stream piştgirî dike. |
| GET | /api/v2/aiservice/openai/v1/responses/{responseId} | Bersiva tomarkirî ya yekê digere. |
| GET | /api/v2/aiservice/openai/v1/responses/{responseId}/input_items | Lîsteya hêmanên têketinê yên bersiva tomarkirî ye. |
| POST | /api/v2/aiservice/openai/v1/responses/{responseId}/cancel | Bersiva ku di paşperdeyê de pêşde diçe betal dike. |
| DELETE | /api/v2/aiservice/openai/v1/responses/{responseId} | Bersiva tomarkirî jê dibe. |
| POST | /api/v2/aiservice/openai/v1/completions | Temamkirina nivîsa kevn. stream piştgirî dike. |
| POST | /api/v2/aiservice/openai/v1/embeddings | Çêkirina embeddingê. Streaming piştgirî nake. |
| GET | /api/v2/aiservice/openai/v1/models | Lîsteya modelên ku bi vê kilîtê dikarin bêne bangkirin e. |
| GET | /api/v2/aiservice/openai/v1/models/{modelId} | Modela yekê digere. Heke nekaribe bigihîje wê, 404 e. |
curl https://platform.clevi.net/api/v2/aiservice/openai/v1/chat/completions \
-H "X-API-Key: sk-..." \
-H "Content-Type: application/json" \
-d '{
"model": "cip-5.5-im",
"messages": [{"role": "user", "content": "안녕하세요"}]
}'Di cihê sk-... de kilîta ku li ser rûpela API key hatiye çêkirin, û di model de ID-ya rûpela modelê binivîsin.
Rêçên din
| Rê | Danasîn |
|---|---|
| GET /api/v2/aiservice/openai/v1/healthz | Rewşa providerê dengê kontrol dike. |
| /api/v2/aiservice/openai/v1/api/status · /api/options · /api/generate · /outputs/{filename} | Rewş û vebijarkên Cosa ya kevn digere, bangên hilberandinê (multipart) dike û encaman dadixe. |
| /api/v2/aiservice/openai/v1/{routeKey} (GET · POST · PUT · PATCH · DELETE) | Rêyên providerê yên li jor nehatine lîstekirin bi sepandina rêgezê vediguhezîne. Ger bi navgîniya POST chat/completions, completions, embeddings an responses bang bikin, 404 tê vegerandin; her çar rêyên taybet wan dikin. |
Rêya lihevhatî ya Anthropic
base URL https://platform.clevi.net/api/v2/aiservice/anthropic e û Anthropic SDK bixwe /v1 li rêyê zêde dike. Naveroka daxwaz û bersivê li gorî standarda Anthropic Messages e.
| Rêbaz | Rê | Rave |
|---|---|---|
| POST | /api/v2/aiservice/anthropic/v1/messages | Bangek li gorî standarda Messages. model·messages·max_tokens pêwîstin û stream tê piştgirîkirin. |
| POST | /api/v2/aiservice/anthropic/v1/messages/count_tokens | Tenê hejmara tokenên ketan texmîn dike, bêyî lêçûnê. max_tokens ne pêwîst e. |
| GET | /api/v2/aiservice/anthropic/v1/models | Lîsteya modelan bi pagination-a cursorê ye. limit ji 1 heta 1000 e; ger derbas bibe, 400 tê vegerandin. |
| GET | /api/v2/aiservice/anthropic/v1/models/{modelId} | Agahiyên yek modelê digire. Ger nebe gihiştin, 404 tê vegerandin. |
curl https://platform.clevi.net/api/v2/aiservice/anthropic/v1/messages \
-H "X-API-Key: sk-..." \
-H "anthropic-version: 2023-06-01" \
-H "Content-Type: application/json" \
-d '{
"model": "cip-5.5-im",
"max_tokens": 1024,
"messages": [{"role": "user", "content": "안녕하세요"}]
}'Streaming (SSE)
ئەگەر "stream": true لە ناوەڕۆکی داواکارییەکە دابنێیت، ڕاژەکارەکە وەڵام بە Server-Sent Events دەدات. بە پێی ڕێڕەو و مۆدێلەکە بە شێوەی خوارەوە جیاوازە.
| ئامانج | کردار |
|---|---|
| OpenAI گونجاو POST /chat/completions · POST /completions · POST /responses | stream پشتگیری دەکات. |
| Anthropic گونجاو POST /v1/messages | stream پشتگیری دەکات. |
| POST /embeddings | پشتگیری لە streaming ناکات. |
| مۆدێلەکانی گەڕانی Ivy (وەک ivy-4-mm-search) | تەنانەت ئەگەر stream چالاک بکەیت، ڕاژەکارەکە ناچالاکی دەکات و وەڵامەکە یەکجار دەنێرێت. |
| GET /responses/{responseId}?stream=true | بە 400 ڕەت دەکرێتەوە. ئەمە ڕێڕەوێکە کە داخراوە تا بتوانرێت بەکارهێنانی وەڵامەکانی پشتپەردە بە دروستی تەنها جارێک پێوانە بکرێت. |
لەگەڵ یەکەم چانکدا سێ سەردێڕی خوارەوە دەنێردرێن. دواتر، لەگەڵ هەر چانکێکدا event: هێڵ (تەنها کاتێک upstream ناوی ڕووداوەکەی دابین کردبێت) و data: هێڵ دەنێرێت و دەستبەجێ flush دەکات.
- Content-Type: text/event-stream
- Cache-Control: no-cache
- X-Accel-Buffering: no
چانکەکانی ڕێڕەوی Anthropic گونجاو بە event هێڵ و data هێڵ بە جووت دێن.
event: content_block_delta
data: {"type":"content_block_delta","index":0,"delta":{"type":"text_delta","text":"안"}}چانکەکانی chat/completions بە data هێڵ دێن و لە کۆتاییدا data: [DONE] بە هەمان شێوە دەگوازرێتەوە.
data: {"id":"chatcmpl-...","object":"chat.completion.chunk","choices":[...]}
data: [DONE]ڕێڕەوەکانی دەنگ و ڤۆیس
ڕێڕەوەکانی TTS·STT و بەڕێوەبردنی ڤۆیسی Cosa لە ستانداردی OpenAI گونجاودان و چەند ڕێسایەکیان هەیە کە لە استنتاجی ئاسایی جیاوازن. ئەوەی کام مۆدێل کام ڕێڕەو ڕێگەپێدراوە، لە خشتەی Cosa لە پەڕەی مۆدێلەکەدا هەیە.
| شێواز | ڕێڕەو | وەسف |
|---|---|---|
| POST | /api/v2/aiservice/openai/v1/audio/speech | دەق بۆ دەنگ دەگۆڕێت و ڕاستەوخۆ دایدەبەزێنێت. |
| POST | /api/v2/aiservice/openai/v1/audio/transcriptions | دەنگ بۆ دەق دەنووسێتەوە (multipart). |
| POST | /api/v2/aiservice/openai/v1/audio/speech/clone | بە دەنگی کۆپیکراو دەنگ بەرهەم دەهێنێت (multipart). |
| GET | /api/v2/aiservice/openai/v1/voices | لیستی ئەو دەنگانەیە کە دەتوانم بەکاریان بهێنم. |
| POST | /api/v2/aiservice/openai/v1/voices | بە نموونەی دەنگ دەنگێک تۆمار دەکات (multipart). |
| POST | /api/v2/aiservice/openai/v1/voices/design | بە وەسفێک دەنگێکی دەستکرد دروست دەکات. |
| DELETE | /api/v2/aiservice/openai/v1/voices/{voiceId} | دەنگەکە دەسڕێتەوە. تەنها خاوەنەکەی دەتوانێت ئەمە بکات. |
| یاسا | ناوەڕۆک |
|---|---|
| Şandina binary | Bersiva serkeftî ya audio/speech, audio/speech/clone, outputs/{filename} dengê wekî xwe diherikîne û di heman demê de wê li CleviDrive tomar dike. |
| Sernavên receiptê | X-Clevi-Drive-File-Id, X-Clevi-Drive-File-Version-Id, X-Clevi-Drive-Download-Url, X-Clevi-Drive-Expires-At, X-Clevi-Drive-Retention-Days: 3 têne şandin. Demê parastinê 3 rojan e û piştî wê 404 e. |
| Hilbijartina Product | audio/speech û audio/transcriptions Product bi model a di nav nivîsê de hilbijêrin. Rêyên deng û teşxîsê hewceyî sernavê X-Product-Sku an pirsên product_sku ne. |
| Xwedîtiya dengê | Dengên ku tên klonkirin û tomar kirin girêdayî aliyê ku wan çêkiriye ne. Heke hûn bi dengê kesekî din sentez bikin an jê bibin, bersiva 403 tê dayîn, û lîsteya GET /voices jî tenê dengên xwediyê we nîşan dide. |
| Mezinahî û dem | Sînorê daxwazê 28 MiB e, û sînorê dema bangkirina upstreamê 5 xulek e. |
| Qerebalixa providerê | Heke upstream mijûl be, 409 bê guhertin tê şandin û heke Retry-After hebe, ew nirx jî tê şandin. Gatewayê ne nûve dike û ne jî dixe nav rêzê. |