Dulmar

Endpoint-yo

Endpoint kasta wuxuu ku jiraa hal base URL waxaana lagu bixiyaa HTTPS.

https://api.shannon-ai.com

Saddexda endpoint ee qoraalka soo saara waxay gaaraan isla model-yada. Dooro midka qaabkiisa code-kaagu horeba u isticmaalo.

Aasaaska codsiga

• Jidhka POST kasta waa hal shay JSON ah, ilaa 32 MiB.
• Field API-gu aanu aqoon khalad ma keeno wax saamayn ahna ma leh. Codsi loogu qoray bixiye kale uma fashilmo field dheeraad ah dartiis.
• Field la yaqaan oo leh nooc JSON qaldan, ama field loo baahan yahay oo maqan, waxaa lagu jawaabaa 422. Jidh aan ahayn JSON sax ah waxaa lagu jawaabaa 400.
• model waa mid ka mid ah id-yada Model-yo & qiimo. Xarfaha waaweyn iyo yaryar muhiim ma aha.

Jawaab waa JSON, ama stream server-sent events ah marka codsigu dejiyo stream true. Endpoint kastaa wuxuu ku jawaabaa qaabkiisa. Jawaab kasta waxay leedahay header-ka x-request-id.

Waxa codsi dhaafo

Codsi waxaa loo hubiyaa kala horreyn go'an ka hor inta model-ku orodin. Hubinta ugu horreysa ee fashilanta ayaa jawaabta, sidaas darteed 401 wali jidhka wax kuguma sheego.

Qaabka khaladka

Khaladku waa shay JSON ah oo leh error haysta type iyo message. /v1/messages wuxuu duubaa sida SDK-yada Anthropic u filaan; jid kasta oo kale wuxuu isticmaalaa qaabka OpenAI.

{
  "error": {
    "type": "invalid_request_error",
    "message": "unknown model: gpt-4o"
  }
}

{
  "type": "error",
  "error": {
    "type": "invalid_request_error",
    "message": "unknown model: gpt-4o"
  }
}

• Akhri type iyo message. code iyo param waxay ka muuqdaan khaladaad qaar oo keliya: u aqoon sida ikhtiyaari. param had iyo jeer waa null.
• Ka dib marka stream bilaabmo, xaaladdu horeba waa 200. Fashil kaddib wuxuu u yimaadaa sida frame khalad ah stream dhexdiisa.
• Jawaab khalad kasta waxay sidaa header-ka x-request-id.

Khaladaadka Maareynta

Bixin iyo haraag

• Akoon kasta wuxuu leeyahay hal haraag, chat-ka iyo API-guna way wadaagaan: marka hore allowance-ka qorshaha ee maanta, kaddib credit la iibsaday. API-gu quota u gaar ah ma laha.
• Codsi wuxuu keydiyaa miisaaniyadda output-kiisa (max_tokens, default 4,096) kaddibna waxaa lagu dallacaa token-yada uu runtii isticmaalay, qiimaha model-ka.
• Jawaab kasta waxay usage ku sheegtaa tirada token-yadeeda. Bogga Fure & isticmaal wuxuu muujiyaa haraagga iyo waxa codsi kastaa ku kacay.
• Codsi kasta si siman ayaa loo bixiyaa. Xadka keliya ee heerka codsiyada waa flood protection: 120 codsi daqiiqad kasta akoon kasta. Codsiyada isku mar la diro safka ayay ku sugaan.

Xadad iyo haraag Model-yo & qiimo Fure & isticmaal

Field-yada ku xiran model-ka

Model kasta wuxuu qaataa isla codsiga. Dhowr field ayaa ka shaqeeya model qaar oo keliya; shaxdu waxay sheegaysaa halka. Bogagga endpoint-ku waxay liis garaynayaan field kasta.

Chat Completions

Haddii aad ka timaado SDK OpenAI

• Deji base URL-ka https://api.shannon-ai.com/v1 iyo furaha furahaaga Shannon. Wicitaannada Chat Completions iyo Responses kaddib waxay ula shaqeeyaan SDK-ga sida uu yahay.
• model waa inuu ahaadaa id Shannon ah. Magac model oo bixiye kale ah, sida gpt-4o, waxaa lagu jawaabaa 400 iyo unknown model.
• Reasoning wuxuu u yimaadaa field u gaar ah: reasoning_content content agtiisa, fariinta iyo stream deltas labadaba.
• Stream had iyo jeer wuxuu usage ku sidaa chunk-kiisa ugu dambeeya, finish_reason la socda.
• Wicitaan tool ee stream-ka wuxuu u yimaadaa sida hal chunk oo leh string-ka arguments oo dhammaystiran.
• Jawaabtu waxay leedahay hal choice.
• Jidadka API-ga OpenAI ee aan shaxda kore ku jirin, sida /v1/embeddings, waxaa lagu jawaabaa 404.

Haddii aad ka timaado SDK Anthropic

• Deji base URL-ka https://api.shannon-ai.com, /v1 la'aantiis, iyo furaha furahaaga Shannon. SDK-gu wuxuu u diraa sida x-api-key.
• model waa inuu ahaadaa id Shannon ah.
• max_tokens waa ikhtiyaari API-gan. Default-kiisu waa 4,096.
• Jawaab waxay haysaa content blocks oo noocyadu yihiin thinking, text iyo tool_use. Block-ga ugu horreeya had iyo jeer ma aha qoraalka: blocks-ka ku dooro type.
• stop_reason waa end_turn ama tool_use. Stream model Shannon ah wuxuu sidoo kale ku dhammaan karaa max_tokens.
• anthropic-version iyo anthropic-beta waa la aqbalaa, sidaas darteed SDK-gu wuu shaqeeyaa isbeddel la'aan. Codsigu uma baahna.
• Khaladaadka /v1/messages waxay leeyihiin qaabka Anthropic: {"type": "error", "error": {…}}.

Qalabka coding-ka ee ku hadla qaababkan waxaa loo dejiyaa si isku mid ah: base URL, fure, iyo id Shannon sida model. Qalabka CLI ee coding-ka