Developer guide

API വിളിക്കുക

API അനുയോജ്യമായ പാതകളും സ്ട്രീമിംഗ്·വോയ്സ് നിയമങ്ങളും

ഈ പേജ് പ്രാമാണീകരണം പൂർത്തിയാക്കിയ ശേഷം യഥാർത്ഥത്തിൽ വിളിക്കേണ്ട പാതകളെക്കുറിച്ചാണ്.
OpenAI അനുയോജ്യമായ പാതകളുടെയും Anthropic അനുയോജ്യമായ പാതകളുടെയും പട്ടിക, അഭ്യർത്ഥന ബോഡിയിൽ stream ഓൺ ചെയ്തപ്പോൾ പ്രതികരണം ലഭിക്കുന്ന രീതി,
വോയ്സ്·വോയ്സ് പാതകൾക്ക് മാത്രം ബാധകമായ നിയമങ്ങൾ എന്നിവയുടെ ക്രമമാണിത്.
മോഡൽ ID-യും ഓരോ മോഡലിനും അനുവദിച്ചിട്ടുള്ള കോളുകളും മോഡൽ പേജിലും, പ്രാമാണീകരണ ഹെഡറും base URL-ഉം API കീ ഉപയോഗിച്ച് പ്രാമാണീകരിക്കുക എന്ന പേജിലുമുണ്ട്.

നടപടി പാത

രണ്ട് അനുയോജ്യതാ മാനദണ്ഡങ്ങളും ഒരേ API കീ ഉപയോഗിക്കുന്നു, സംഭാഷണാത്മക റീസണിംഗ് മോഡലുകളെ ഏതെങ്കിലും മാനദണ്ഡം ഉപയോഗിച്ച് വിളിക്കാം. ചെയ്യാനുദ്ദേശിക്കുന്ന കാര്യത്തിനും ഉപയോഗിച്ചിരുന്ന SDK-ക്കും അനുസരിച്ച് പാത തിരഞ്ഞെടുക്കുക.

ചെയ്യാനുദ്ദേശിക്കുന്ന കാര്യം	മാനദണ്ഡം	പാത
സംഭാഷണാത്മക റീസണിംഗ്, OpenAI SDK ഉപയോഗം	OpenAI അനുയോജ്യം	POST /chat/completions അല്ലെങ്കിൽ POST /responses
സംഭാഷണാത്മക റീസണിംഗ്, Anthropic SDK ഉപയോഗം	Anthropic അനുയോജ്യം	POST /v1/messages
എംബെഡ്ഡിംഗ് സൃഷ്ടിക്കൽ	OpenAI അനുയോജ്യം	POST /embeddings
വോയ്സ് സിന്തസിസ്·ട്രാൻസ്ക്രിപ്ഷൻ, വോയ്സ് മാനേജ്മെന്റ്	OpenAI അനുയോജ്യം	/audio, /voices എന്നിവയ്ക്ക് കീഴിലുള്ള പാതകൾ
വിളിക്കാനാകുന്ന മോഡലുകൾ പരിശോധിക്കൽ	രണ്ടും	GET /models

OpenAI അനുയോജ്യമായ പാത

base URL https://platform.clevi.net/api/v2/aiservice/openai/v1 ആണ്, അഭ്യർത്ഥനയുടെയും പ്രതികരണത്തിന്റെയും ബോഡികൾ OpenAI മാനദണ്ഡം പിന്തുടരുന്നു. താഴെയുള്ള പട്ടിക റീസണിംഗിനും മോഡൽ പാതകൾക്കുമുള്ളതാണ്; വോയ്സ്·വോയ്സ് പാതകൾ അടുത്ത വിഭാഗത്തിൽ പ്രത്യേകം ക്രമീകരിച്ചിരിക്കുന്നു.

രീതി	പാത	വിവരണം
POST	/api/v2/aiservice/openai/v1/chat/completions	സംഭാഷണാത്മക ഇൻഫറൻസ്. stream പ്രവർത്തനക്ഷമമാക്കിയാൽ SSE ആയി പ്രതികരണം നൽകുന്നു.
POST	/api/v2/aiservice/openai/v1/responses	Responses ഫോർമാറ്റിലുള്ള കോൾ. stream പിന്തുണയ്ക്കുന്നു.
GET	/api/v2/aiservice/openai/v1/responses/{responseId}	സംരക്ഷിച്ച ഒരു പ്രതികരണം ലഭ്യമാക്കുന്നു.
GET	/api/v2/aiservice/openai/v1/responses/{responseId}/input_items	സംരക്ഷിച്ച പ്രതികരണത്തിന്റെ ഇൻപുട്ട് ഇനങ്ങളുടെ പട്ടിക.
POST	/api/v2/aiservice/openai/v1/responses/{responseId}/cancel	പശ്ചാത്തലത്തിൽ പുരോഗമിക്കുന്ന പ്രതികരണം റദ്ദാക്കുന്നു.
DELETE	/api/v2/aiservice/openai/v1/responses/{responseId}	സംരക്ഷിച്ച പ്രതികരണം ഇല്ലാതാക്കുന്നു.
POST	/api/v2/aiservice/openai/v1/completions	ലെഗസി ടെക്സ്റ്റ് പൂർത്തീകരണം. stream പിന്തുണയ്ക്കുന്നു.
POST	/api/v2/aiservice/openai/v1/embeddings	എംബെഡ്ഡിംഗ് സൃഷ്ടിക്കുന്നു. സ്ട്രീമിംഗ് പിന്തുണയ്ക്കുന്നില്ല.
GET	/api/v2/aiservice/openai/v1/models	ഈ കീ ഉപയോഗിച്ച് വിളിക്കാവുന്ന മോഡലുകളുടെ പട്ടിക.
GET	/api/v2/aiservice/openai/v1/models/{modelId}	ഒരു മോഡൽ ലഭ്യമാക്കുന്നു. ആക്‌സസ് ചെയ്യാനാകുന്നില്ലെങ്കിൽ 404 ആണ്.

Bash

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": "안녕하세요"}]
  }'

sk-... എന്നിടത്ത് API കീ സ്‌ക്രീനിൽ നിന്ന് ലഭിച്ച കീയും, model എന്നതിൽ മോഡൽ പേജിലെ IDയും നൽകുക.

മറ്റ് പാതകൾ

പാത	വിവരണം
GET /api/v2/aiservice/openai/v1/healthz	വോയ്സ് provider-ന്റെ നില പരിശോധിക്കുന്നു.
/api/v2/aiservice/openai/v1/api/status · /api/options · /api/generate · /outputs/{filename}	ലെഗസി Cosa-യുടെ നിലയും ഓപ്ഷനുകളും പരിശോധിക്കൽ, ജനറേഷൻ കോൾ (multipart), ഔട്ട്പുട്ട് ഡൗൺലോഡ് എന്നിവയ്ക്കുള്ളതാണ്.
/api/v2/aiservice/openai/v1/{routeKey} (GET · POST · PUT · PATCH · DELETE)	മുകളിൽ ഉൾപ്പെടാത്ത provider പാതകളെ നിയമങ്ങൾ പ്രയോഗിച്ച് റിലേ ചെയ്യുന്നു. POST റിലേയിലൂടെ chat/completions, completions, embeddings, responses വിളിച്ചാൽ 404 ലഭിക്കും; ഇവ നാലും സമർപ്പിത പാതകളാണ് കൈകാര്യം ചെയ്യുന്നത്.

Anthropic-അനുരൂപ പാത

base URL https://platform.clevi.net/api/v2/aiservice/anthropic ആണ്, കൂടാതെ Anthropic SDK പാതയിലേക്ക് /v1 സ്വമേധയാ ചേർക്കുന്നു. അഭ്യർത്ഥനയുടെയും പ്രതികരണത്തിന്റെയും ബോഡികൾ Anthropic Messages സ്പെസിഫിക്കേഷൻ പിന്തുടരുന്നു.

രീതി	പാത	വിവരണം
POST	/api/v2/aiservice/anthropic/v1/messages	Messages സ്പെസിഫിക്കേഷൻ കോൾ. model·messages·max_tokens ആവശ്യമാണ്, കൂടാതെ stream പിന്തുണയ്ക്കുന്നു.
POST	/api/v2/aiservice/anthropic/v1/messages/count_tokens	ചാർജ് ഇല്ലാതെ ഇൻപുട്ട് ടോക്കണുകളുടെ എണ്ണം മാത്രം കണക്കാക്കുന്നു. max_tokens ആവശ്യമില്ല.
GET	/api/v2/aiservice/anthropic/v1/models	കർസർ പേജിനേഷൻ ഉപയോഗിച്ചുള്ള മോഡൽ പട്ടിക. limit 1~1000 ആയിരിക്കണം; പരിധി കവിയുകയാണെങ്കിൽ 400 ലഭിക്കും.
GET	/api/v2/aiservice/anthropic/v1/models/{modelId}	ഒരു മോഡലിന്റെ വിവരങ്ങൾ നേടുന്നു. ആക്സസ് ചെയ്യാനാകാത്തപ്പോൾ 404 ലഭിക്കും.

Bash

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": "안녕하세요"}]
  }'

സ്ട്രീമിംഗ് (SSE)

അഭ്യർത്ഥന ബോഡിയിൽ "stream": true ചേർത്താൽ സെർവർ Server-Sent Events ആയി പ്രതികരിക്കും. പാതയും മോഡലും അനുസരിച്ച് ഇത് താഴെപ്പറയുന്ന രീതിയിൽ വ്യത്യാസപ്പെടുന്നു.

ലക്ഷ്യം	പ്രവർത്തനം
OpenAI അനുയോജ്യമായ POST /chat/completions · POST /completions · POST /responses	stream പിന്തുണയ്ക്കുന്നു.
Anthropic അനുയോജ്യമായ POST /v1/messages	stream പിന്തുണയ്ക്കുന്നു.
POST /embeddings	സ്ട്രീമിംഗ് പിന്തുണയ്ക്കുന്നില്ല.
Ivy തിരയൽ ശ്രേണി മോഡലുകൾ (ivy-4-mm-search മുതലായവ)	stream ഓണാക്കിയാലും സെർവർ അത് ഓഫാക്കി ഒറ്റത്തവണയായി പ്രതികരിക്കും.
GET /responses/{responseId}?stream=true	400 ഉപയോഗിച്ച് നിരസിക്കും. പശ്ചാത്തല പ്രതികരണത്തിന്റെ ഉപയോഗം കൃത്യമായി ഒരിക്കൽ മാത്രം അളക്കാൻ കഴിയുന്നതുവരെ അടച്ചിട്ടിരിക്കുന്ന പാതയാണിത്.

ആദ്യ ചങ്കിനൊപ്പം താഴെപ്പറയുന്ന മൂന്ന് ഹെഡറുകൾ അയയ്ക്കും. തുടർന്ന് ഓരോ ചങ്കിലും event: വരി (അപ്‌സ്ട്രീം ഇവന്റ് പേര് നൽകിയിട്ടുണ്ടെങ്കിൽ മാത്രം), 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}	വോയ്സ് ഇല്ലാതാക്കുന്നു. ഉടമയ്ക്ക് മാത്രമേ ഇത് ചെയ്യാനാകൂ.

ശബ്ദം·വോയ്സ് പാതകൾക്ക് മാത്രം ബാധകമായ നിയമങ്ങൾ

നിയമം	ഉള്ളടക്കം
ബൈനറി കൈമാറ്റം	audio/speech, audio/speech/clone, outputs/{filename} എന്നിവയുടെ വിജയകരമായ പ്രതികരണം ഓഡിയോ അതേപടി സ്ട്രീം ചെയ്യുന്നതിനൊപ്പം CleviDrive-ൽ സംരക്ഷിക്കുന്നു.
രസീത് ഹെഡറുകൾ	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 എന്നിവ ലഭിക്കും. നിലനിർത്തൽ കാലയളവ് 3 ദിവസമാണ്; അതിന് ശേഷം 404 ആയിരിക്കും.
Product തിരഞ്ഞെടുക്കൽ	audio/speech, audio/transcriptions എന്നിവ body-യിലെ model ഉപയോഗിച്ച് Product തിരഞ്ഞെടുക്കുന്നു. വോയ്സ്, ഡയഗ്നോസ്റ്റിക് പാതകൾക്ക് X-Product-Sku ഹെഡർ അല്ലെങ്കിൽ product_sku query ആവശ്യമാണ്.
വോയ്സിന്റെ ഉടമസ്ഥാവകാശം	ക്ലോൺ ചെയ്തും രജിസ്റ്റർ ചെയ്തും ഉള്ള വോയ്സുകൾ സൃഷ്ടിച്ച സ്ഥാപനത്തിന്റേതായിരിക്കും. മറ്റൊരാളുടെ വോയ്സ് ഉപയോഗിച്ച് സിന്തസൈസ് ചെയ്യാനോ ഇല്ലാതാക്കാനോ ശ്രമിച്ചാൽ 403 ലഭിക്കും; GET /voices പട്ടികയിലും സ്വന്തം ഉടമസ്ഥതയിലുള്ളവ മാത്രം ശേഷിക്കും.
വലുപ്പവും സമയവും	അഭ്യർത്ഥനയുടെ പരമാവധി പരിധി 28 MiB ആണ്; അപ്‌സ്ട്രീം കോൾ സമയപരിധി 5 മിനിറ്റാണ്.
provider തിരക്ക്	അപ്‌സ്ട്രീം തിരക്കിലാണെങ്കിൽ 409 അതേപടി കൈമാറും; Retry-After നൽകിയിട്ടുണ്ടെങ്കിൽ ആ മൂല്യവും കൈമാറും. ഗേറ്റ്‌വേ വീണ്ടും ശ്രമിക്കുകയോ ക്യൂവിൽ ചേർക്കുകയോ ഇല്ല.

API വിളിക്കുക

നടപടി പാത

OpenAI അനുയോജ്യമായ പാത

മറ്റ് പാതകൾ

Anthropic-അനുരൂപ പാത

സ്ട്രീമിംഗ് (SSE)

ശബ്ദവും വോയ്സ് പാതകളും

ഭാഷയും പ്രദേശവും

ശുപാർശ ചെയ്തത്

കിഴക്കൻ ഏഷ്യ

തെക്ക്-കിഴക്കൻ ഏഷ്യ

തെക്കേ ഏഷ്യ

മദ്ധ്യേഷ്യ

മധ്യപൂർവ ദേശവും കോക്കസസും

പശ്ചിമ യൂറോപ്പ് കൂടാതെ തെക്കേ യൂറോപ്പ്

യുണൈറ്റഡ് കിംഗ്ഡം കൂടാതെ അയർലൻഡ്

വടക്കേ യൂറോപ്പ്

മധ്യ യൂറോപ്പും ബാൽക്കണും

കിഴക്കൻ യൂറോപ്പ്

കിഴക്കൻ ആഫ്രിക്ക

പശ്ചിമ ആഫ്രിക്ക കൂടാതെ മദ്ധ്യ ആഫ്രിക്ക

തെക്കേ ആഫ്രിക്ക

അമേരിക്കകൾ

ഓഷ്യാനിയ