Ħarsa ġenerali

Endpoints

Kull endpoint jinsab taħt base URL waħda u jiġi servut fuq HTTPS.

https://api.shannon-ai.com

It-tliet endpoints li jipproduċu test jilħqu l-istess mudelli. Agħżel dak li l-format tiegħu diġà juża l-kodiċi tiegħek.

Bażi tat-talbiet

• Il-body ta' kull POST huwa oġġett JSON wieħed, sa 32 MiB.
• Qasam li l-API ma tafx ma jikkawża l-ebda żball u m'għandu l-ebda effett. Talba miktuba għal fornitur ieħor ma tfallix minħabba qasam żejjed.
• Qasam magħruf bit-tip JSON ħażin, jew qasam meħtieġ nieqes, jitwieġeb b'422. Body li mhuwiex JSON validu jitwieġeb b'400.
• model huwa wieħed mill-ids fi Models & pricing. Ittri kbar u żgħar ma jgħoddux.

Tweġiba hija JSON, jew stream ta' server-sent events meta t-talba tissettja stream għal true. Kull endpoint iwieġeb fil-format tiegħu. Kull tweġiba għandha l-header x-request-id.

Minn xiex tgħaddi talba

Talba tiġi ċċekkjata f'ordni fissa qabel ma jaħdem mudell. L-ewwel kontroll li jfalli jwieġeb, għalhekk 401 għadu ma jgħidlek xejn dwar il-body.

Forma tal-iżball

Żball huwa oġġett JSON b'error li fih type u message. /v1/messages jgeżwer l-iżball kif jistennew l-SDKs ta' Anthropic; kull path ieħor juża l-forma OpenAI.

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

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

• Aqra type u message. code u param huma preżenti fuq xi żbalji biss: qisha fakultattivi. param huwa dejjem null.
• Wara li jkun beda stream, l-istatus huwa diġà 200. Falliment imbagħad jasal bħala frame ta' żball ġewwa l-istream.
• Kull tweġiba ta' żball iġġorr l-header x-request-id.

Ġestjoni tal-iżbalji

Ħlas u bilanċ

• Hemm bilanċ wieħed għal kull kont, u l-chat u l-API jaqsmuh: l-ewwel il-kwota tal-pjan ta' illum, imbagħad il-kreditu imxri. L-API m'għandha l-ebda kwota tagħha.
• Talba tirriżerva l-baġit tal-output tagħha (max_tokens, default 4,096) u mbagħad titħallas għat-tokens li użat tassew, bil-prezz tal-mudell.
• Kull tweġiba tirrapporta l-għadd ta' tokens tagħha f'usage. Il-paġna Keys & usage turi l-bilanċ u kemm swiet kull talba.
• Kull talba tiġi servuta bl-istess mod. L-uniku limitu fuq ir-rata tat-talbiet huwa l-protezzjoni mill-flood: 120 talba kull minuta għal kull kont. Talbiet mibgħuta b'mod parallel jistennew fil-kju.

Limiti u bilanċ Mudelli u prezzijiet Ċwievet u użu

Kampi li jiddependu mill-mudell

Kull mudell jieħu l-istess talba. Ftit kampi jaħdmu fuq xi mudelli biss; it-tabella tisemmi fejn. Il-paġni tal-endpoints jelenkaw kull qasam.

Chat Completions

Jekk tiġi minn SDK ta' OpenAI

• Issettja l-base URL għal https://api.shannon-ai.com/v1 u ċ-ċavetta għaċ-ċavetta Shannon tiegħek. Is-sejħiet ta' Chat Completions u Responses imbagħad jaħdmu mal-SDK kif inhu.
• model irid ikun id ta' Shannon. Isem ta' mudell ta' fornitur ieħor, bħal gpt-4o, jitwieġeb b'400 u unknown model.
• Ir-raġunament jiġi f'qasam tiegħu: reasoning_content maġenb content, fil-messaġġ u fid-deltas tal-istream.
• Stream dejjem iġorr usage fl-aħħar chunk tiegħu, flimkien ma' finish_reason.
• Sejħa ta' tool fi stream tasal bħala chunk wieħed bl-istring kompluta ta' arguments.
• Tweġiba għandha choice waħda.
• Il-paths tal-API ta' OpenAI li mhumiex fit-tabella ta' hawn fuq, bħal /v1/embeddings, jitwieġbu b'404.

Jekk tiġi minn SDK ta' Anthropic

• Issettja l-base URL għal https://api.shannon-ai.com, mingħajr /v1, u ċ-ċavetta għaċ-ċavetta Shannon tiegħek. L-SDK jibgħatha bħala x-api-key.
• model irid ikun id ta' Shannon.
• max_tokens huwa fakultattiv fuq din l-API. Id-default tiegħu huwa 4,096.
• Tweġiba fiha blokki tal-kontenut tat-tip thinking, text u tool_use. L-ewwel blokk mhuwiex dejjem it-test: agħżel il-blokki skont type.
• stop_reason huwa end_turn jew tool_use. Stream ta' mudell Shannon jista' jispiċċa wkoll b'max_tokens.
• anthropic-version u anthropic-beta jiġu aċċettati, għalhekk l-SDK jaħdem mingħajr tibdil. Talba ma teħtieġhomx.
• L-iżbalji fuq /v1/messages għandhom il-forma Anthropic: {"type": "error", "error": {…}}.

L-għodod tal-kodiċi li jitkellmu dawn il-formats jiġu ssettjati bl-istess mod: base URL, ċavetta, u id ta' Shannon bħala l-mudell. Għodod CLI għall-kodiċi