Muhtasari

Endpoint

Kila endpoint iko chini ya base URL moja na inahudumiwa kupitia HTTPS.

https://api.shannon-ai.com

Endpoint tatu zinazozalisha maandishi hufikia model zile zile. Chagua ile ambayo umbizo lake code yako tayari inatumia.

Misingi ya ombi

• Mwili wa kila POST ni kitu kimoja cha JSON, hadi 32 MiB.
• Field ambayo API haijui haisababishi kosa na haina athari. Ombi lililoandikwa kwa mtoa huduma mwingine halifeli kwa sababu ya field ya ziada.
• Field inayojulikana yenye aina isiyo sahihi ya JSON, au field inayohitajika iliyokosekana, hujibiwa kwa 422. Mwili usio JSON halali hujibiwa kwa 400.
• model ni mojawapo ya id zilizo kwenye Model na bei. Herufi kubwa na ndogo hazijalishi.

Jibu ni JSON, au stream ya server-sent events ombi linapoweka stream kuwa true. Kila endpoint hujibu kwa umbizo lake. Kila jibu lina header ya x-request-id.

Ombi hupitia nini

Ombi hukaguliwa kwa mpangilio uliowekwa kabla model haijaendeshwa. Ukaguzi wa kwanza unaoshindwa ndio unaojibu, kwa hiyo 401 bado haikuambii chochote kuhusu mwili.

Umbo la kosa

Kosa ni kitu cha JSON chenye error inayoshikilia type na message. /v1/messages hulifunga kama SDK za Anthropic zinavyotarajia; kila path nyingine hutumia umbo la OpenAI.

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

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

• Soma type na message. code na param zipo kwenye baadhi ya makosa pekee: zichukulie kama hiari. param daima ni null.
• Baada ya stream kuanza, hali tayari ni 200. Hitilafu basi hufika kama frame ya kosa ndani ya stream.
• Kila jibu la kosa hubeba header ya x-request-id.

Ushughulikiaji wa Makosa

Malipo na salio

• Kuna salio moja kwa kila akaunti, na chat na API hulitumia pamoja: kwanza kiasi cha mpango wa leo, kisha mikopo uliyonunua. API haina quota yake yenyewe.
• Ombi hutenga bajeti yake ya output (max_tokens, chaguo-msingi 4,096) na kisha hutozwa kwa tokens ilizotumia kweli, kwa bei ya model.
• Kila jibu huripoti hesabu zake za tokens kwenye usage. Ukurasa wa Keys na matumizi unaonyesha salio na kila ombi liligharimu nini.
• Kila ombi linahudumiwa kwa usawa. Kikomo pekee cha kasi ya maombi ni flood protection: maombi 120 kwa dakika kwa kila akaunti. Maombi yanayotumwa kwa sambamba husubiri kwenye foleni.

Mipaka na salio Model na bei Keys na matumizi

Fields zinazotegemea model

Kila model inakubali ombi lile lile. Fields chache zinafanya kazi kwenye baadhi ya model pekee; jedwali linataja mahali. Kurasa za endpoint zinaorodhesha kila field.

Chat Completions

Ukitoka kwenye SDK ya OpenAI

• Weka base URL kuwa https://api.shannon-ai.com/v1 na key kuwa key yako ya Shannon. Wito wa Chat Completions na Responses kisha hufanya kazi na SDK kama ilivyo.
• model lazima iwe id ya Shannon. Jina la model la mtoa huduma mwingine, kama gpt-4o, hujibiwa kwa 400 na unknown model.
• Reasoning huja kwenye field yake yenyewe: reasoning_content kando ya content, kwenye ujumbe na kwenye stream deltas.
• Stream daima hubeba usage kwenye chunk yake ya mwisho, pamoja na finish_reason.
• Wito wa tool kwenye stream hufika kama chunk moja yenye string kamili ya arguments.
• Jibu lina choice moja.
• Paths za OpenAI API ambazo hazimo kwenye jedwali la juu, kama /v1/embeddings, hujibiwa kwa 404.

Ukitoka kwenye SDK ya Anthropic

• Weka base URL kuwa https://api.shannon-ai.com, bila /v1, na key kuwa key yako ya Shannon. SDK huituma kama x-api-key.
• model lazima iwe id ya Shannon.
• max_tokens si lazima kwenye API hii. Chaguo-msingi ni 4,096.
• Jibu lina content blocks za aina thinking, text na tool_use. Block ya kwanza si daima maandishi: chagua blocks kwa type.
• stop_reason ni end_turn au tool_use. Stream ya model ya Shannon inaweza pia kuisha na max_tokens.
• anthropic-version na anthropic-beta zinakubaliwa, kwa hiyo SDK inafanya kazi bila mabadiliko. Ombi halizihitaji.
• Makosa kwenye /v1/messages yana umbo la Anthropic: {"type": "error", "error": {…}}.

Coding tools zinazotumia umbizo hizi husanidiwa kwa njia ile ile: base URL, key, na id ya Shannon kama model. Zana za CLI za kuandika code