Chidule
Mapu a API: endpoint iliyonse, momwe pempho ndi cholakwika zimaonekera, momwe ma call amalipidwira, ndi zomwe muyenera kudziwa mukachokera ku OpenAI kapena Anthropic SDK.
Ma endpoint
Endpoint iliyonse ili pansi pa base URL imodzi ndipo imatumikiridwa pa HTTPS.
https://api.shannon-ai.com | Endpoint | Mtundu | Cholinga chake |
|---|---|---|
POST /v1/chat/completions | OpenAI Chat Completions | Tumizani zokambirana, landirani yankho lotsatira. Ndi streaming kapena popanda. |
POST /v1/messages | Anthropic Messages | Chimodzimodzi, mu mawonekedwe a pempho ndi yankho a Anthropic SDK. |
POST /v1/responses | OpenAI Responses | Chimodzimodzi, mu mawonekedwe a Responses. Endpoint siisunga state: tumizani zokambirana ndi pempho lililonse. |
GET /v1/models | Mndandanda wa ma model wa OpenAI | Lembani ma model ndi context window, mitengo ndi capabilities. Siifuna kiyi. |
POST /v1/tokenize | Shannon API | Werengani ma token a text kapena a pempho la chat pa hosted open-weight model. Kwaulere. |
POST /v1/messages/count_tokens | Kuwerenga ma token kwa Anthropic | Werengani ma input token a pempho la Messages pa hosted open-weight model. Kwaulere. |
Ma endpoint atatu opanga text amafika ku ma model omwewo. Sankhani yomwe mtundu wake code yanu imagwiritsa ntchito kale.
Zofunika za pempho
| Header | Kufotokozera |
|---|---|
Authorization: Bearer <key> | API key yanu. Yofunika pa endpoint iliyonse kupatula GET /v1/models, pokhapokha mutatumiza x-api-key. |
x-api-key: <key> | Kiyi yomweyo mu header yomwe ma Anthropic SDK amatumiza. Imawerengedwa pa endpoint iliyonse. |
Content-Type: application/json | Yofunika pa POST iliyonse. Popanda iyo yankho ndi 415. |
x-request-id: <your id> | Mwasankha. Id yanu ya pempho; imabwerera mu header ya yankho x-request-id. Popanda iyo API imapanga yokhala ndi zilembo 12 za hexadecimal. |
- Body ya
POSTiliyonse ndi JSON object imodzi, mpaka 32 MiB. - Field yomwe API siidziwa siyimayambitsa cholakwika ndipo siigwira ntchito. Pempho lolembedwera wopereka wina silikulephera chifukwa cha field yowonjezera.
- Field yodziwika yokhala ndi JSON type yolakwika, kapena field yofunika yosowa, imayankhidwa ndi
422. Body yomwe si JSON yovomerezeka imayankhidwa ndi400. modelndi imodzi mwa ma id a pa Models & pricing. Zilembo zazikulu ndi zazing'ono sizimakhudza.
Yankho ndi JSON, kapena stream ya server-sent events pamene pempho likhazikitsa stream kukhala true. Endpoint iliyonse imayankha mu mtundu wake. Yankho lililonse lili ndi header ya x-request-id.
Zomwe pempho limadutsa
Pempho limayang'aniridwa motsatira dongosolo lokhazikika model isanayende. Kuyang'ana koyamba kolephera ndiko kuyankha, choncho 401 sikukuuzani kanthu pa body.
| Imayang'aniridwa, motsatira izi | Status ikalephera |
|---|---|
| API key | 401 |
| Body: kukula, content type, JSON, ma type a field | 413 · 415 · 400 · 422 |
| Model id | 400 |
| Flood protection: ma pempho 120 pa mphindi pa akaunti | 429 |
| Balance: output budget ya pempho iyenera kukwana | 429 |
Mawonekedwe a cholakwika
Cholakwika ndi JSON object yokhala ndi error yomwe ili ndi type ndi message. /v1/messages imaikulunga monga momwe ma Anthropic SDK amayembekezera; njira ina iliyonse imagwiritsa ntchito mawonekedwe a OpenAI.
{
"error": {
"type": "invalid_request_error",
"message": "unknown model: gpt-4o"
}
} {
"type": "error",
"error": {
"type": "invalid_request_error",
"message": "unknown model: gpt-4o"
}
} - Werengani
typendimessage.codendiparamzimakhalapo pa zolakwika zina zokha: zitengeni ngati zosafunika.paramnthawi zonse ndinull. - Stream ikayamba, status yakhala kale
200. Cholakwika chimafika ngati error frame mkati mwa stream. - Yankho lililonse la cholakwika limanyamula header ya
x-request-id.
| Status | Mtundu | Liti |
|---|---|---|
400 | invalid_request_error | Body si JSON yovomerezeka, model id siidziwika, kapena model siilandira mtundu wa input womwe mwatumiza. |
401 | authentication_error | Kiyi ikusowa kapena siyovomerezeka. |
404 | not_found_error | Njira kulibe. |
405 | api_error | Njira ilipo, method ndi yolakwika. |
413 | invalid_request_error | Body ndi yayikulu kuposa 32 MiB. |
415 | invalid_request_error | Content-Type si application/json. |
422 | invalid_request_error | Field ili ndi JSON type yolakwika kapena field yofunika ikusowa. |
429 | rate_limit_error | Balance siikwana pempho, ma pempho opitirira 120 afika mu mphindi imodzi, ma call a Shannon Coder a window atha, kapena model ili otanganidwa. Message imanena chomwe. |
5xx | api_error | Status 500, 502, 503 kapena 504: pempho linali lovomerezeka ndipo silinathe kuyankhidwa. Tumizaninso. 500 ikhoza kunyamula type server_error. |
Malipiro ndi balance
- Pali balance imodzi pa akaunti, ndipo chat ndi API zimagawana: allowance ya plan ya lero poyamba, kenako credit yomwe munagula. API ilibe quota yake.
- Pempho limasunga output budget yake (
max_tokens, default 4,096) ndipo kenako limaperekedwa mtengo wa ma token omwe lagwiritsa ntchito kwenikweni, pa mtengo wa model. - Yankho lililonse limanena chiwerengero cha ma token ake mu
usage. Tsamba la Keys & usage limaonetsa balance ndi zomwe pempho lililonse lawononga. - Pempho lililonse limatumikiridwa mofanana. Malire okhawo a kuchuluka kwa ma pempho ndi flood protection: ma pempho 120 pa mphindi pa akaunti. Ma pempho otumizidwa nthawi imodzi amadikira pamzere.
Malire ndi balance Ma model ndi mitengo Keys & usage
Ma field omwe amadalira model
Model iliyonse imalandira pempho lomwelo. Ma field ochepa amagwira ntchito pa ma model ena okha; table imatchula komwe. Masamba a endpoint amalemba field iliyonse.
| Field | Kufotokozera | Imagwira ntchito pa |
|---|---|---|
system | Malangizo a model: message ya system pa Chat Completions, system pa Messages, instructions pa Responses. | Hosted open-weight model, shannon-1.6-*, shannon-2-*, shannon-coder-1 |
temperature | Sampling temperature. | Hosted open-weight model, shannon-1.6-*, shannon-coder-1 |
top_p | Nucleus sampling. | Hosted open-weight model |
seed | Seed yokhazikika ya sampling. | Hosted open-weight model |
stop | Mpaka ma stop sequence 4. | Hosted open-weight model |
reasoning_effort | Momwe model imaganizira isanayankhe. reasoning.effort pa Responses, thinking pa Messages. | Hosted open-weight model |
web_search | true imalola model kusaka pa web pa pempho ili. Field ya API iyi, pa Chat Completions ndi Messages. | Ma model a Shannon kupatula shannon-coder-1 |
max_tokens | Output budget. Pa model iliyonse imakhazikitsa kuchuluka komwe kumasungidwa pa balance yanu. | Ngati malire a kutalika kwa yankho: hosted open-weight model, shannon-1.6-*, shannon-coder-1 |
Mukachokera ku OpenAI SDK
- Khazikitsani base URL kukhala
https://api.shannon-ai.com/v1ndi kiyi kukhala kiyi yanu ya Shannon. Ma call a Chat Completions ndi Responses amagwira ntchito ndi SDK monga ilili. modeliyenera kukhala id ya Shannon. Dzina la model la wopereka wina, mongagpt-4o, limayankhidwa ndi400ndiunknown model.- Reasoning imabwera mu field yake:
reasoning_contentpambali pacontent, mu message ndi mu ma stream delta. - Stream nthawi zonse imanyamula
usagemu chunk yake yomaliza, pamodzi ndifinish_reason. - Call ya tool mu stream imafika ngati chunk imodzi yokhala ndi string yathunthu ya
arguments. - Yankho lili ndi choice imodzi.
- Njira za OpenAI API zomwe sizili mu table yomwe ili pamwambapa, monga
/v1/embeddings, zimayankhidwa ndi404.
Mukachokera ku Anthropic SDK
- Khazikitsani base URL kukhala
https://api.shannon-ai.com, popanda/v1, ndi kiyi kukhala kiyi yanu ya Shannon. SDK imaitumiza ngatix-api-key. modeliyenera kukhala id ya Shannon.max_tokensndi yosafunika pa API iyi. Default yake ndi 4,096.- Yankho lili ndi content block za type
thinking,textnditool_use. Block yoyamba si nthawi zonse text: sankhani ma block nditype. stop_reasonndiend_turnkapenatool_use. Stream ya model ya Shannon ikhozanso kutha ndimax_tokens.anthropic-versionndianthropic-betazimalandiridwa, kotero SDK imagwira ntchito popanda kusintha. Pempho siliyenera kukhala nazo.- Zolakwika pa
/v1/messageszili ndi mawonekedwe a Anthropic:{"type": "error", "error": {…}}.
Ma tool a coding omwe amalankhula mitundu iyi amakhazikitsidwa chimodzimodzi: base URL, kiyi, ndi id ya Shannon ngati model. Zida za CLI zolembera code