Uhlaka

Ama-endpoint

Wonke ama-endpoint ayi-base URL eyodwa futhi asetshenziswa nge-HTTPS.

https://api.shannon-ai.com

Ama-endpoint amathathu akhiqiza umbhalo afinyelela kuma-model afanayo. Khetha lowo isimo sawo ikhodi yakho esisebenzisa kakade.

Izinto eziyisisekelo zesicelo

• Umzimba we-POST ngayinye yi-JSON object eyodwa, kufika ku-32 MiB.
• I-field engaziwa yi-API ayibangeli phutha futhi ayinamphumela. Isicelo esibhalelwe omunye umhlinzeki asehluleki ngenxa ye-field eyengeziwe.
• I-field eyaziwayo enohlobo lwe-JSON olungalungile, noma i-field edingekayo engekho, iphendulwa nge-422. Umzimba ongeyona i-JSON esebenzayo uphendulwa nge-400.
• I-model ingenye yama-id aku-Models & pricing. Ukuthi onkulu noma amancane akunandaba.

Impendulo iyi-JSON, noma i-stream ye-server-sent events lapho isicelo sisetha i-stream ibe true. I-endpoint ngayinye iphendula ngesimo sayo. Yonke impendulo inayo i-header ethi x-request-id.

Okudlula isicelo

Isicelo sihlolwa ngokulandelana okumisiwe ngaphambi kokuba i-model ihambe. Ukuhlola kokuqala okwehlulekayo kuyaphendula, ngakho i-401 ayikutsheli lutho ngomzimba.

Isimo sephutha

Iphutha yi-JSON object ene-error ephethe type ne-message. I-/v1/messages iyiboshela ngendlela ama-SDK e-Anthropic ayilindele ngayo; zonke ezinye izindlela zisebenzisa isimo se-OpenAI.

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

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

• Funda i-type ne-message. I-code ne-param ziba khona kwamanye amaphutha kuphela: zithathe njengezikhethwa. I-param ihlala iyi-null.
• Ngemuva kokuba i-stream iqalile, isimo sesiyi-200. Ukwehluleka kufika njenge-error frame ngaphakathi kwe-stream.
• Yonke impendulo yephutha iphethe i-header ethi x-request-id.

Ukuphathwa kwamaphutha

Ukukhokha ne-balance

• Ku-akhawunti ngayinye kunebhalansi eyodwa, futhi ingxoxo ne-API kuyabelana ngayo: kuqala i-plan allowance yanamuhla, bese i-credit ethengiwe. I-API ayinayo i-quota yayo.
• Isicelo sigcina isabelomali saso sokuphumayo (max_tokens, okuvamile 4,096) bese sikhokhiswa ama-token asetshenziswe ngempela, ngentengo ye-model.
• Yonke impendulo ibika izibalo zama-token ayo ku-usage. Ikhasi le-Keys & usage likhombisa i-balance nokubiza kwesicelo ngasinye.
• Isicelo ngasinye siphathwa ngokulinganayo. Umkhawulo okuwukuphela wezinga lezicelo i-flood protection: izicelo ezingu-120 ngomzuzu ngakhawunti. Izicelo ezithunyelwe ngokufanayo zilinda emgqeni.

Imikhawulo ne-balance Ama-model namanani Ama-key nokusetshenziswa

Ama-field ancike ku-model

Wonke ama-model amukela isicelo esifanayo. Ama-field ambalwa asebenza kuma-model athile kuphela; ithebula likhomba lapho. Amakhasi ama-endpoint abhala wonke ama-field.

Chat Completions

Uma uvela ku-SDK ye-OpenAI

• Setha i-base URL ibe https://api.shannon-ai.com/v1 bese i-key ibe yi-Shannon key yakho. Izicelo ze-Chat Completions ne-Responses ziyasebenza ne-SDK injengoba injalo.
• I-model kufanele ibe yi-id ye-Shannon. Igama le-model lomunye umhlinzeki, elinjenge-gpt-4o, liphendulwa nge-400 ne-unknown model.
• Ukucabanga kufika ku-field yako: i-reasoning_content eduze kwe-content, emlayezweni nakuma-stream delta.
• I-stream ihlala iphethe i-usage ku-chunk yayo yokugcina, kanye ne-finish_reason.
• Isicelo sethuluzi ku-stream sifika njenge-chunk eyodwa enesikhwama (string) esiphelele se-arguments.
• Impendulo ine-choice eyodwa.
• Izindlela ze-API ye-OpenAI ezingekho etafuleni elingenhla, ezinjenge-/v1/embeddings, ziphendulwa nge-404.

Uma uvela ku-SDK ye-Anthropic

• Setha i-base URL ibe https://api.shannon-ai.com, ngaphandle kwe-/v1, bese i-key ibe yi-Shannon key yakho. I-SDK iyithumela njenge-x-api-key.
• I-model kufanele ibe yi-id ye-Shannon.
• I-max_tokens ayiphoqelekile kule-API. Okuvamile ngu-4,096.
• Impendulo iphethe ama-content block ohlobo thinking, text ne-tool_use. Ibhlokhi yokuqala akuhlali kuyimbhalo: khetha amabhlokhi nge-type.
• I-stop_reason iyi-end_turn noma tool_use. I-stream ye-model ye-Shannon ingaphinde iphele nge-max_tokens.
• I-anthropic-version ne-anthropic-beta ziyamukelwa, ngakho i-SDK isebenza ngaphandle kokushintshwa. Isicelo asizidingi.
• Amaphutha ku-/v1/messages anesimo se-Anthropic: {"type": "error", "error": {…}}.

Amathuluzi okubhala ikhodi akhuluma lezi zimo amiswa ngendlela efanayo: i-base URL, i-key, ne-id ye-Shannon njenge-model. Amathuluzi e-CLI okukhoda