ናብ ትሕዝቶ ዝለል
መግለጺ

መግለጺ

ካርታ ናይ API፦ ነፍሲ ወከፍ endpoint፣ ጠለብን ጌጋን ከመይ ከም ዝመስል፣ ጥሪታት ከመይ ከም ዝኽፈሉ፣ ከምኡውን ካብ OpenAI ወይ Anthropic SDK ክትመጽእ ከሎ እንታይ ክፍለጥ ከም ዘለዎ።

Endpoints

ነፍሲ ወከፍ endpoint ኣብ ትሕቲ ሓደ base URL ይርከብ ከምኡውን ብHTTPS ይቐርብ።

Base URL 
https://api.shannon-ai.com
Endpoint ቅርጺ ንምንታይ ዝኸውን
POST /v1/chat/completions OpenAI Chat Completions ዘተ ልኣኽ፣ ዝቕጽል መልሲ ተቐበል። ብstreaming ወይ ብዘይ streaming።
POST /v1/messages Anthropic Messages እቲ ተመሳሳሊ፣ ኣብ ቅርጽታት ጠለብን ምላሽን ናይ Anthropic SDKs።
POST /v1/responses OpenAI Responses እቲ ተመሳሳሊ፣ ኣብ ቅርጽታት Responses። እቲ endpoint ኩነታት ኣየቐምጥን፦ ዘተ ምስ ነፍሲ ወከፍ ጠለብ ልኣኽ።
GET /v1/models ዝርዝር ሞዴላት OpenAI ሞዴላት ምስ context window፣ ዋጋታትን ክእለታትን ዘርዝር። ቁልፊ ኣየድልን።
POST /v1/tokenize Shannon API Tokens ናይ ጽሑፍ ወይ ናይ chat ጠለብ ንዝተሃንደሰ open-weight ሞዴል ቁጸር። ነጻ።
POST /v1/messages/count_tokens ቆጸራ token ናይ Anthropic ኣተዋዕዎ tokens ናይ Messages ጠለብ ንዝተሃንደሰ open-weight ሞዴል ቁጸር። ነጻ።

እቶም ሰለስተ ጽሑፍ ዘፍጥሩ endpoints ንተመሳሳሊ ሞዴላት የበጽሑ። ቅርጹ ኮድካ ድሮ ዝጥቀሞ ምረጽ።

መሰረታዊ ጠለብ

Header መግለጺ
Authorization: Bearer <key> API ቁልፍኻ። ኣብ ነፍሲ ወከፍ endpoint ብዘይ GET /v1/models የድሊ፣ x-api-key እንተ ዘየለኣኽካ።
x-api-key: <key> እቲ ተመሳሳሊ ቁልፊ ኣብ header ዝልእኽዎ Anthropic SDKs። ኣብ ነፍሲ ወከፍ endpoint ይነበብ።
Content-Type: application/json ኣብ ነፍሲ ወከፍ POST የድሊ። ብዘይ እዚ እቲ ምላሽ 415 እዩ።
x-request-id: <your id> ኣማራጺ። ናትካ ባዕልኻ id ናይ ጠለብ፤ ኣብ ናይ ምላሽ header x-request-id ይምለስ። ብዘይ እዚ እቲ API ካብ 12 hexadecimal ፊደላት ሓደ ይፈጥር።
  • እቲ body ናይ ነፍሲ ወከፍ POST ሓደ JSON object እዩ፣ ክሳብ 32 MiB።
  • እቲ API ዘይፈልጦ field ጌጋ ኣየምጽእን ከምኡውን ሳዕቤን የብሉን። ንካልእ provider ዝተጻሕፈ ጠለብ ብሰንኪ ትርፊ field ኣይወድቕን።
  • ዝፍለጥ field ምስ ጌጋ JSON ዓይነት፣ ወይ ዝጎደለ ግዴታ field ብ 422 ይምለስ። ቅኑዕ JSON ዘይኮነ body ብ 400 ይምለስ።
  • model ሓደ ካብ ids ኣብ ሞዴላትን ዋጋን እዩ። ዓቐን ፊደል የገድስን።

ምላሽ JSON እዩ፣ ወይ እቲ ጠለብ stream ናብ true እንተ ኣዘጋጂኡ ናይ server-sent events stream እዩ። ነፍሲ ወከፍ endpoint ብናቱ ቅርጺ ይምልስ። ኩሉ ምላሽ header x-request-id ኣለዎ።

ሓደ ጠለብ ዘሕልፎ ምርመራታት

ጠለብ ቅድሚ ሞዴል ምስራሑ ብርጉእ ትእዛዝ ይምርመር። እቲ ዝወደቐ ቀዳማይ ምርመራ ይምልስ፣ ስለዚ 401 ብዛዕባ body ገና ዋላ ሓንቲ ኣይነግረካን።

ብዚ ትእዛዝ ዝምርመር ኩነታት ምስ ዝወድቕ
API ቁልፊ 401
Body፦ ዓቐን፣ ዓይነት ትሕዝቶ፣ JSON፣ ዓይነታት fields 413 · 415 · 400 · 422
ሞዴል id 400
Flood protection፦ 120 ጠለባት ኣብ ደቒቕ ንነፍሲ ወከፍ ኣካውንት 429
ሚዛን፦ ባጀት ውጽኢት ናይ ጠለብ ክሰፍሕ ኣለዎ 429

ቅርጺ ጌጋ

ጌጋ type ከምኡውን message ዝሓዘ error ዘለዎ JSON object እዩ። /v1/messages ከምቲ Anthropic SDKs ዝጽበይዎ ይጠቀልሎ፤ ነፍሲ ወከፍ ካልእ መንገዲ ቅርጺ OpenAI ይጥቀም።

{
  "error": {
    "type": "invalid_request_error",
    "message": "unknown model: gpt-4o"
  }
}
  • type ከምኡውን message ኣንብብ። code ከምኡውን param ኣብ ገለ ጌጋታት ጥራይ ይርከቡ፦ ከም ኣማራጺ ወስዶም። param ኩሉ ግዜ null እዩ።
  • stream ምስ ጀመረ፣ እቲ ኩነታት ድሮ 200 እዩ። ውድቀት ሽዑ ከም error frame ኣብ ውሽጢ stream ይመጽእ።
  • ነፍሲ ወከፍ ናይ ጌጋ ምላሽ header x-request-id ይሓዝ።
ኩነታት ዓይነት መዓስ
400 invalid_request_error እቲ body ቅኑዕ JSON ኣይኮነን፣ እቲ id ናይ ሞዴል ኣይፍለጥን፣ ወይ እቲ ሞዴል ዝለኣኽካዮ ዓይነት ኣተዋብ ኣይቅበልን።
401 authentication_error እቲ ቁልፊ ጎደሎ ወይ ቅኑዕ ኣይኮነን።
404 not_found_error እቲ መገዲ የለን።
405 api_error እቲ መገዲ ኣሎ፣ እቲ method ግን ጌጋ እዩ።
413 invalid_request_error እቲ body ካብ 32 MiB ይዓቢ።
415 invalid_request_error Content-Type application/json ኣይኮነን።
422 invalid_request_error ሓደ field ጌጋ ዓይነት JSON ኣለዎ ወይ ዘድሊ field ጎደሎ እዩ።
429 rate_limit_error እቲ ሚዛን ነቲ ጠለብ ኣይሽፍንን፣ ኣብ ሓደ ደቒቕ ልዕሊ 120 ጠለባት መጺኦም፣ ናይቲ መስኮት Shannon Coder ጥሪታት ወዲኦም፣ ወይ እቲ ሞዴል ተጸሚዱ ኣሎ። እቲ መልእኽቲ ኣየናይ ምዃኑ ይብል።
5xx api_error Status 500፣ 502፣ 503 ወይ 504፦ እቲ ጠለብ ቅኑዕ ነይሩ ግን ክምለስ ኣይከኣለን። ደጊምካ ልኣኽ። 500 ዓይነት server_error ክሕዝ ይኽእል።

ሓጋይ ኣስተዳደር

ክፍሊትን ሚዛንን

  • ንነፍሲ ወከፍ ኣካውንት ሓደ ሚዛን ኣሎ፣ chat ከምኡውን API ድማ ይሓባበርዎ፦ ቀዳማይ ናይ ሎሚ allowance ናይ ፕላን፣ ደሓር ዝተገዝአ credit። እቲ API ናቱ ባዕሉ quota የብሉን።
  • ሓደ ጠለብ ባጀት ውጽኢቱ (max_tokens፣ ነባሪ 4,096) ይዕቅብ ደሓር ብዝተጠቐመ ሓቀኛ tokens ብዋጋ ናይ ሞዴል ይኽፈል።
  • ነፍሲ ወከፍ ምላሽ ቁጽሪ tokens ናቱ ኣብ usage ይሕብር። እቲ ገጽ ቁልፍታትን ኣጠቓቕማን ሚዛንን ነፍሲ ወከፍ ጠለብ ክንደይ ከም ዝኸፈለ የርኢ።
  • ነፍሲ ወከፍ ጠለብ ብማዕረ ይቐርብ። እቲ ሓደ ገደብ ኣብ ደረጃ ጠለብ flood protection እዩ፦ 120 ጠለባት ኣብ ደቒቕ ንነፍሲ ወከፍ ኣካውንት። ብሓባር ዝልእኹ ጠለባት ኣብ ሰልፊ ይጽበዩ።

ገደባትን ሚዛንን ሞዴላትን ዋጋን ቁልፍታትን ኣጠቓቕማን

ብሞዴል ዝውሰኑ field ታት

ነፍሲ ወከፍ ሞዴል ተመሳሳሊ ጠለብ ይቕበል። ገለ fields ኣብ ገለ ሞዴላት ጥራይ ይትግበሩ፤ እቲ ሰንጠረዥ ኣበይ ከም ዝኾነ ይሰምዮ። እቲ ገጻት ናይ endpoint ነፍሲ ወከፍ field ይዝርዝሩ።

Field መግለጺ ዝተጠቐመሉ
system መምርሕታት ንሞዴል፦ system መልእኽቲ ኣብ Chat Completions፣ system ኣብ Messages፣ instructions ኣብ Responses። ዝተሃንደሱ open-weight ሞዴላት፣ shannon-1.6-*፣ shannon-2-*፣ shannon-coder-1
temperature Sampling temperature። ዝተሃንደሱ open-weight ሞዴላት፣ shannon-1.6-*፣ shannon-coder-1
top_p Nucleus sampling። ዝተሃንደሱ open-weight ሞዴላት
seed ንናሙና ምውሳድ (sampling) ዝኸውን ቀዋሚ seed። ዝተሃንደሱ open-weight ሞዴላት
stop ክሳብ 4 ዝኾኑ ናይ ምቁም ተኸታታሊታት (stop sequences)። ዝተሃንደሱ open-weight ሞዴላት
reasoning_effort እቲ ሞዴል ቅድሚ ምምላሱ ክሳብ ክንደይ ይሓስብ። reasoning.effort ኣብ Responses፣ thinking ኣብ Messages። ዝተሃንደሱ open-weight ሞዴላት
web_search true እቲ ሞዴል ንዚ ጠለብ ኣብ web ክደሊ የኽእሎ። ናይ እዚ API field፣ ኣብ Chat Completions ከምኡውን Messages። ሞዴላት Shannon ብዘይ shannon-coder-1
max_tokens ባጀት ውጽኢት። ኣብ ነፍሲ ወከፍ ሞዴል ካብ ሚዛንካ ዝተዓቆበ መጠን የዘጋጅ። ከም ገደብ ኣብ ርዝመት መልሲ፦ ዝተሃንደሱ open-weight ሞዴላት፣ shannon-1.6-*፣ shannon-coder-1

Chat Completions

ካብ OpenAI SDK እንተ መጺኦም

  • base URL ናብ https://api.shannon-ai.com/v1 ኣዘጋጅ ከምኡውን ቁልፊ ናብ Shannon ቁልፍኻ። ጥሪታት Chat Completions ከምኡውን Responses ሽዑ ምስ SDK ከምዘሎ ይሰርሑ።
  • model Shannon id ክኸውን ኣለዎ። ናይ ካልእ provider ሞዴል ስም፣ ከም gpt-4o፣ ብ 400 ከምኡውን unknown model ይምለስ።
  • Reasoning ኣብ ናቱ field ይመጽእ፦ reasoning_content ኣብ ጥቓ content፣ ኣብ መልእኽቲ ከምኡውን ኣብ stream deltas።
  • ሓደ stream ኩሉ ግዜ usage ኣብ ናይ መወዳእታ chunk ምስ finish_reason ተሓቒፉ ይሕዝ።
  • ኣብ stream ዘሎ ጥሪ tool ከም ሓደ chunk ምስ ምሉእ arguments string ይመጽእ።
  • ሓደ ምላሽ ሓደ choice ኣለዎ።
  • ኣብቲ ላዕሊ ሰንጠረዥ ዘየለዉ መንገድታት ናይ OpenAI API፣ ከም /v1/embeddings፣ ብ 404 ይምለሱ።

ካብ Anthropic SDK እንተ መጺኦም

  • base URL ናብ https://api.shannon-ai.com ኣዘጋጅ፣ ብዘይ /v1፣ ከምኡውን ቁልፊ ናብ Shannon ቁልፍኻ። እቲ SDK ከም x-api-key ይልእኾ።
  • model Shannon id ክኸውን ኣለዎ።
  • max_tokens ኣብዚ API ኣማራጺ እዩ። ነባሪኡ 4,096 እዩ።
  • ሓደ ምላሽ content blocks ዓይነት thinking፣ text ከምኡውን tool_use ይሓዝ። እቲ ቀዳማይ block ኩሉ ግዜ ጽሑፍ ኣይኮነን፦ blocks ብ type ምረጾም።
  • stop_reason end_turn ወይ tool_use እዩ። stream ናይ ሞዴል Shannon ብ max_tokens እውን ክውዳእ ይኽእል።
  • anthropic-version ከምኡውን anthropic-beta ይቕበሉ፣ ስለዚ እቲ SDK ከይተቐየረ ይሰርሕ። ጠለብ ኣየድልዮምን።
  • ጌጋታት ኣብ /v1/messages ቅርጺ Anthropic ኣለዎም፦ {"type": "error", "error": {…}}።

እዞም ቅርጽታት ዝዛረቡ ናይ ኮዲንግ መሳለጥያታት ብተመሳሳሊ ይዳለዉ፦ base URL፣ ቁልፊ፣ ከምኡውን Shannon id ከም ሞዴል። CLI ናይ ኮዲንግ መሳለጥያታት