Topimaso

Endpoint

Ny endpoint rehetra dia ao ambanin'ny base URL iray ary tanterahina amin'ny HTTPS.

https://api.shannon-ai.com

Ny endpoint telo mamokatra soratra dia mahazo model mitovy. Fidio izay endrika efa ampiasain'ny kaody-nao.

Fototry ny fangatahana

• Ny body an'ny POST rehetra dia object JSON iray, hatramin'ny 32 MiB.
• Ny saha tsy fantatry ny API dia tsy mahatonga hadisoana ary tsy misy vokany. Ny fangatahana nosoratana ho an'ny mpamatsy hafa dia tsy tsy mahomby noho ny saha fanampiny.
• Ny saha fantatra misy karazana JSON diso, na saha ilaina tsy misy, dia valiana amin'ny 422. Ny body tsy JSON mety dia valiana amin'ny 400.
• Ny model dia iray amin'ny id ao amin'ny Models & pricing. Tsy mijery ny litera lehibe/kely.

Ny valiny dia JSON, na stream server-sent events rehefa mametraka ny stream ho true ny fangatahana. Ny endpoint tsirairay dia mamaly amin'ny endriny manokana. Ny valiny rehetra dia manana header x-request-id.

Izay lalovan'ny fangatahana

Ny fangatahana dia hamarinina araka filaharana raikitra alohan'ny hampandehanana model. Ny fanamarinana voalohany tsy mahomby no mamaly, ka ny 401 dia tsy milaza na inona na inona momba ny body.

Endrik'ny hadisoana

Ny hadisoana dia object JSON misy error mitazona type sy message. Ny /v1/messages dia mampiditra azy araka izay andrasan'ny SDK Anthropic; ny lalana hafa rehetra dia mampiasa endrika OpenAI.

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

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

• Vakio ny type sy message. Ny code sy param dia misy amin'ny hadisoana sasany ihany: heveriny ho safidy. Ny param dia foana null.
• Aorian'ny fanombohan'ny stream, 200 ny status. Ny tsy fahombiazana avy eo dia tonga ho frame hadisoana ao anaty stream.
• Ny valiny hadisoana rehetra dia mitondra header x-request-id.

Fitantanana hadisoana

Fandoavam-bola sy balance

• Balance iray isaky ny kaonty, ary ny chat sy ny API dia mizara izany: allowance an'ny plan anio aloha, avy eo credit novidina. Ny API dia tsy manana quota manokana.
• Ny fangatahana dia mitahiry ny budget output-ny (max_tokens, default 4,096) ary avy eo vidiana araka ny token nampiasainy marina, amin'ny vidin'ny model.
• Ny valiny rehetra dia milaza ny isan'ny token ao amin'ny usage. Ny pejy Keys & usage dia mampiseho ny balance sy ny vidin'ny fangatahana tsirairay.
• Ny fangatahana rehetra dia tanterahina mitovy. Ny hany fetra amin'ny tahan'ny fangatahana dia ny flood protection: fangatahana 120 isa-minitra isaky ny kaonty. Ny fangatahana alefa miaraka dia miandry ao anaty filaharana.

Fetra sy balance Model & vidiny Keys & usage

Saha miankina amin'ny model

Ny model rehetra dia mandray fangatahana mitovy. Misy saha vitsivitsy manana vokany amin'ny model sasany ihany; ny tabilao no manonona izay. Ny pejin'ny endpoint dia mitanisa ny saha rehetra.

Chat Completions

Avy amin'ny SDK OpenAI

• Apetraho ho https://api.shannon-ai.com/v1 ny base URL ary ho Shannon key-nao ny key. Mandeha araka ny itoviany miaraka amin'ny SDK avy eo ny antso Chat Completions sy Responses.
• Tsy maintsy id Shannon ny model. Ny anaran'ny model an'ny mpamatsy hafa, toy ny gpt-4o, dia valiana amin'ny 400 sy unknown model.
• Ny reasoning dia tonga amin'ny saha manokana: reasoning_content eo anilan'ny content, ao amin'ny hafatra sy ny delta stream.
• Ny stream dia mitondra foana usage ao amin'ny chunk farany, miaraka amin'ny finish_reason.
• Ny tool call ao anaty stream dia tonga ho chunk iray misy ny string arguments feno.
• Ny valiny dia manana choice iray.
• Ny lalana an'ny API OpenAI tsy ao amin'ny tabilao etsy ambony, toy ny /v1/embeddings, dia valiana amin'ny 404.

Avy amin'ny SDK Anthropic

• Apetraho ho https://api.shannon-ai.com ny base URL, tsy misy /v1, ary ho Shannon key-nao ny key. Ny SDK dia mandefa azy ho x-api-key.
• Tsy maintsy id Shannon ny model.
• Safidy ny max_tokens amin'ity API ity. 4,096 ny default-ny.
• Ny valiny dia misy content block karazana thinking, text ary tool_use. Ny block voalohany dia tsy foana ny soratra: fidio araka ny type ny block.
• Ny stop_reason dia end_turn na tool_use. Ny stream an'ny model Shannon dia mety mifarana amin'ny max_tokens koa.
• Raisina ny anthropic-version sy anthropic-beta, ka mandeha tsy miova ny SDK. Tsy ilain'ny fangatahana izy ireo.
• Ny hadisoana amin'ny /v1/messages dia manana endrika Anthropic: {"type": "error", "error": {…}}.

Ny coding tool izay miteny amin'ireto endrika ireto dia raiketina mitovy: base URL, key, ary id Shannon ho model. Fitaovana CLI ho an'ny coding