Ilokhi yezinguquko
Izibuyekezo zakamuva nokuthuthukiswa kwe-Shannon API.
Leli khasi linezinguquko ongazibona njengomsebenzisi we-API: ama-endpoint amasha, ama-field nama-model, ukuziphatha okushintshile nokulungiswa. Okufakiwe kwakamuva kuza kuqala. Okufakiwe ngakunye kuphatha usuku inguquko eyenziwe ngalo.
Okufakiwe okumakwe ngokuthi Okuphukisayo kungashintsha umphumela wesicelo esasisebenza ngaphambilini. I-API inenguqulo eyodwa, /v1, ngakho izinguquko ziqoshwe ngosuku hhayi ngenombolo yenguqulo.
- OKUSHA
Isicelo esine-
web_search: truesibiza imithombo yaso: i-sourcesku-/v1/chat/completionsna-/v1/messagesibala imiphumela i-model eyinikeziwe, futhi ku-/v1/chat/completionsi-annotationsiphawula lapho impendulo icaphuna khona ngayinye. Usesho lwewebhu
- OKUSHA
I-
web_search: trueku-/v1/chat/completionsna-/v1/messagesyenza usesho lwewebhu ngaphambi kokuba i-model iphendule bese iyinika imiphumela njengemithombo enezinombolo. Isicelo esithole imiphumela sisebenzisa usesho olulodwa lwe-allowance yakho yansuku zonke. Uma kungasali lutho, isicelo siphendulwa ngaphandle kosesho. Usesho lwewebhu
- Kulungiwe
I-stream enqunyiwe ohlangothini lwe-server ibiziswa ukusetshenziswa okubikiwe kuze kube yilelo phoyinti. Insalela yokubekelwa eceleni ibuyela ku-balance yakho.
- Kulungiwe
I-
shannon-coder-1iphendula ku-/v1/responsesnjengoba yenza kuma-endpoint amanye amabili. Amathuluzi e-CLI okukhoda - Kulungiwe
I-API key eshintshiwe iyeka ukusebenza ngokushesha.
- OKUSHA
POST /v1/tokenizene-POST /v1/messages/count_tokens: ukubalwa kwama-token mahhala kuma-model e-open-weight ahlinzekiwe. Ukubala ama-token - OKUSHA
I-prompt caching kuma-model e-open-weight ahlinzekiwe. Okufakwayo okugcinwe kubiziswa ku-25% yentengo yokufakwayo futhi kubikwa ku-
usagekuwo wonke ama-endpoint amathathu:prompt_tokens_details.cached_tokens,input_tokens_details.cached_tokensne-cache_read_input_tokens. I-GET /v1/modelsibika i-pricing.cached_input_per_million_usdne-capabilities.prompt_cachingkulawa ma-model. I-Prompt caching - Kulungiwe
Ama-model e-open-weight ahlinzekiwe: i-
tool_choiceephoqelelwe (requirednoma umsebenzi onegama) ikhiqiza ukubiza ithuluzi. Ukubiza umsebenzi - Kulungiwe
Ama-model e-open-weight ahlinzekiwe amukela umlayezo we-
systemongeyona owokuqala engxoxweni.
- OKUSHA
I-API ifinyeleleka njengesevisi ye-onion ye-Tor nakukheli le-I2P. Izimpendulo ze-
api.shannon-ai.comziphatha amakheli amabili kuma-header e-Onion-Locationne-X-I2P-Location. Ama-endpoint abethelwe, e-Tor ne-I2P
- OKUSHA
Ama-model amasha
shannon-3.1no-shannon-3.1-pro, alandelisiwe yi-GET /v1/models. Ama-model namanani - Kushintshiwe
Isicelo esisakazwayo iklayenti laso elinqamukayo siqhubeka size siphele futhi siyabalwa. Ngaphambilini, impendulo yayiyeka lapho kunqamuka.
- Kulungiwe
Izicelo ku-
/v1/responsesziyavela erekhodini lokusetshenziswa.
- OKUSHA
Ama-model e-open-weight ahlinzekiwe asebenzisa ama-field e-sampling:
temperature,top_p,seed,stopne-max_tokensku-/v1/chat/completions;temperature,top_pne-stop_sequencesku-/v1/messages;temperature,top_pne-max_output_tokensku-/v1/responses. Chat Completions - OKUSHA
Irekhodi lokusetshenziswa libonisa izindleko nge-USD ekubizeni ngakunye ngokuphelele.
- Okuphukisayo
Inani le-
modelelingeyona i-id eshicilelwe liphendulwa nge-400, uhloboinvalid_request_errornomlayezounknown model: <id>kuwo wonke ama-endpoint amathathu. Ngaphambilini, isicelo esinjalo sasiphendulwa yi-shannon-1.6-lite. Ama-model namanani - Okuphukisayo
I-
/v1yamukela i-API key kuphela. I-cookie yokungena yewebhusayithi ayifundwa lapho. Ukuqinisekisa - Kushintshiwe
I-flood protection: izicelo ezingu-120 ngomzuzu nge-akhawunti kuma-endpoint amathathu okukhiqiza. Imikhawulo ne-balance
- Kuthuthukisiwe
Uma i-model ingakwazi ukuphendula, iphutha liphatha umlayezo omisiwe othi
The model backend failed to answer. Please retry.Ukuhlola i-balance okungenakwenziwa kuphendulwa nge-503nohloboapi_error. Ukuphathwa kwamaphutha - Kulungiwe
Isicelo esingasakazwa esihluleka sibuyisela ukubekelwa eceleni ku-balance yakho.
- OKUSHA
I-
GET /v1/modelsibika i-capabilities.reasoning_effortku-model ngayinye. Umzamo wokucabanga - Kuthuthukisiwe
Ama-model e-open-weight ahlinzekiwe: isicelo esingasakazwa esingathola mpendulo siphela nge-
504nohloboapi_error. Umphumela ongenalutho ngu-502. Ukuphathwa kwamaphutha
- Okuphukisayo
Ama-model e-open-weight ahlinzekiwe amukela okufakwayo i-model eqanjwe ngayo ekwamukelayo. Isithombe esithunyelwe ku-id yombhalo kuphela siphendulwa nge-
400ne-<id> does not accept image input. I-response_formatku-id engenakho okuphumayo okuhleliwe iphendulwa nge-400. I-GET /v1/modelsibika i-capabilities.vision,response_formatne-json_schemaku-id ngayinye. Izithombe namafayela - Kulungiwe
Izimpendulo ezingasakazwa ziphatha umbhalo wokucabanga: i-
reasoning_contentemlayezweni we-/v1/chat/completions, ne-block ye-thinkingngaphambi kombhalo ku-/v1/messages. Umzamo wokucabanga - Kushintshiwe
Ama-model e-open-weight ahlinzekiwe anamanani amasha, kusukela ku-$0.50 ngama-token okufakwayo ayi-1M no-$2.00 ngama-token okuphumayo ayi-1M. Ama-model namanani
- Kushintshiwe
Ama-model e-open-weight ahlinzekiwe anayo i-id eyodwa nge-model ngayinye, ama-id ayishumi nambili sezizonke. Ama-model namanani
- OKUSHA
Okuphumayo okuhleliwe ku-
shannon-3,shannon-3-pro,shannon-3.1na-shannon-3.1-pro. I-GET /v1/modelsibika i-capabilities.json_schema: truengazo. Imiphumela ehlanganisiwe - OKUSHA
I-
/v1/responsesifunda i-text.format(json_objectnomajson_schema) ngokuphumayo okuhleliwe. I-Responses API - Kulungiwe
I-
/v1/responsesibuyisela ukucabanga kwama-model e-Shannon: into yokuphumayo ye-reasoningngaphambi kwento ye-message, nemicimbi ye-streamresponse.reasoning_summary_text.deltane-response.reasoning_summary_text.done. I-Responses API - Kulungiwe
I-field ye-
modelyempendulo iyi-id eshicilelwe kuwo wonke ama-endpoint. Into ye-Responses iphatha i-modelne-created_at. - Kuthuthukisiwe
I-
GET /v1/modelsibika iwindi lomongo le-model ngayinye. Ama-model namanani
- OKUSHA
Ama-model e-open-weight ahlinzekiwe aphendula ku-
/v1/messagesna-/v1/responseskanye nasekhasini/v1/chat/completions, nge-system prompt yakho nokubiza amathuluzi. I-/v1/messagesyamukela i-thinking, futhi i-reasoning_effortiyi-field yesicelo. Ama-model namanani - Kuthuthukisiwe
Imizimba yamaphutha ku-
/v1ilandela izimo ze-SDK: into ye-errorene-typene-messagekuma-endpoint efomethi ye-OpenAI, nento efanayo ngaphakathi kwe-{"type": "error"}ku-/v1/messages. Ukuphathwa kwamaphutha - OKUSHA
I-Keep-alive ku-stream evulekile njalo emizuzwana engu-15: umugqa wokuphawula we-
: pingku-/v1/chat/completions, i-event: pingku-/v1/messages. Ukusakaza - Kushintshiwe
Ama-id okubiza amathuluzi aqala nge-
call_ku-/v1/chat/completionsna-/v1/responses, nge-toolu_ku-/v1/messages. Ukubiza umsebenzi - Okuphukisayo
/v1/responses: i-streamngokuzenzakalelayo ithifalse. I-Responses API - OKUSHA
I-
max_completion_tokensiyamukelwa njengelinye igama le-max_tokensku-/v1/chat/completions. Chat Completions - Kulungiwe
Umcimbi we-
response.completedwe-stream ye-Responses uphatha uhlu lwe-output. I-Responses API - OKUSHA
Okufakiwe kwe-
GET /v1/modelskuphatha i-display_name,context_window,max_output_tokens,pricing,capabilitiesne-endpoints. Ama-model namanani - OKUSHA
Impendulo ngayinye iphatha i-
x-request-id, futhi inani olithumelayo liyabuyiswa. Imizimba yezicelo ingafika ku-32 MiB. - OKUSHA
I-key ingahoxiswa ngaphandle kokukhishwa kwenye entsha. Irekhodi lokusetshenziswa lihlukaniswe ngamakhasi.
- OKUSHA
Izithombe namadokhumenti ezicelweni: izingxenye ze-
image_urlku-/v1/chat/completions, ama-block e-image,documentne-fileku-/v1/messages, izingxenye ze-input_imageku-/v1/responses. Izithombe namafayela - OKUSHA
I-model entsha
shannon-3-pro. Ama-model namanani
- OKUSHA
I-model entsha
shannon-3. Ama-model namanani - OKUSHA
Ama-stream ku-
/v1/chat/completionsaphatha ukucabanga njenge-delta.reasoning_content. Umzamo wokucabanga
- Kushintshiwe
I-
max_tokensigcinwa phakathi kuka-1 no-65,536. Inani elingaphandle kwalolo hlobo liletshwa ekugcineni okuseduzane, alinqatshwa. Chat Completions
- OKUSHA
I-
shannon-coder-1ibalwa ngezicelo ngepulani ku-/v1/chat/completionsna-/v1/messages. Uma izicelo zewindi sezisetshenzisiwe, impendulo ithi429nomlayezoShannon Coder call quota reached. Amathuluzi e-CLI okukhoda - OKUSHA
Ingxoxo enkulu kunewindi lomongo iphendulwa nge-
400, uhloboinvalid_request_errornekhodicontext_length_exceeded. Iphutha ngaphakathi kwe-stream lifika njengomcimbi wephutha, hhayi njengombhalo empendulweni. Amathuluzi e-CLI okukhoda
- OKUSHA
Ama-endpoint e-
/v1:POST /v1/chat/completions,POST /v1/messages,POST /v1/responsesne-GET /v1/models. Ayizona ama-endpoint abizwa yi-OpenAI ne-Anthropic SDK, i-Claude Code ne-Codex CLI. Uhlaka - OKUSHA
Ukubiza amathuluzi nge-
toolsku-/v1/chat/completionsna-/v1/messages, okuphumayo okuhleliwe nge-response_format, ne-systemnjenge-string noma njengama-block ombhalo ku-/v1/messages. Ukubiza umsebenzi
- OKUSHA
Ama-id e-model
shannon-1.6-pro,shannon-2-lite,shannon-2-prone-shannon-coder-1, eceleni kwe-shannon-1.6-lite. Ama-model namanani
- OKUSHA
Ukukhishwa kokuqala kwe-API: ingxoxo ngefomethi ye-OpenAI nangefomethi ye-Anthropic, ne-endpoint ye-Responses, ngayinye ibizwa nge-API key eqala nge-
sk-. Ukuqinisekisa