ພາບລວມ

Endpoint

ທຸກ endpoint ຢູ່ພາຍໃຕ້ base URL ດຽວ ແລະ ໃຫ້ບໍລິການຜ່ານ HTTPS.

https://api.shannon-ai.com

ສາມ endpoint ທີ່ສ້າງຂໍ້ຄວາມເຂົ້າເຖິງ model ດຽວກັນ. ເລືອກອັນທີ່ຮູບແບບກົງກັບທີ່ໂຄ້ດຂອງທ່ານໃຊ້ຢູ່ແລ້ວ.

ພື້ນຖານຂອງຄຳຮ້ອງຂໍ

• body ຂອງທຸກ POST ແມ່ນ object JSON ໜຶ່ງອັນ, ສູງສຸດ 32 MiB.
• ຟີລດ໌ທີ່ API ບໍ່ຮູ້ຈັກບໍ່ເຮັດໃຫ້ເກີດຂໍ້ຜິດພາດ ແລະ ບໍ່ມີຜົນ. ຄຳຮ້ອງຂໍທີ່ຂຽນສຳລັບຜູ້ໃຫ້ບໍລິການອື່ນບໍ່ລົ້ມເຫຼວຍ້ອນຟີລດ໌ເກີນ.
• ຟີລດ໌ທີ່ຮູ້ຈັກແຕ່ມີປະເພດ JSON ຜິດ, ຫຼື ຂາດຟີລດ໌ທີ່ຈຳເປັນ, ຖືກຕອບດ້ວຍ 422. body ທີ່ບໍ່ແມ່ນ JSON ທີ່ຖືກຕ້ອງຖືກຕອບດ້ວຍ 400.
• model ແມ່ນໜຶ່ງໃນ id ໃນ Models & pricing. ຕົວພິມນ້ອຍ-ໃຫຍ່ບໍ່ສຳຄັນ.

ຄຳຕອບເປັນ JSON, ຫຼື stream ຂອງ server-sent events ເມື່ອຄຳຮ້ອງຂໍຕັ້ງ stream ເປັນ true. ແຕ່ລະ endpoint ຕອບໃນຮູບແບບຂອງຕົນເອງ. ທຸກຄຳຕອບມີ header x-request-id.

ສິ່ງທີ່ຄຳຮ້ອງຂໍຕ້ອງຜ່ານ

ຄຳຮ້ອງຂໍຖືກກວດຕາມລຳດັບຄົງທີ່ກ່ອນ model ຈະເຮັດວຽກ. ການກວດທຳອິດທີ່ບໍ່ຜ່ານຈະເປັນຜູ້ຕອບ, ດັ່ງນັ້ນ 401 ຍັງບໍ່ບອກຫຍັງກ່ຽວກັບ body.

ຮູບຮ່າງຂອງຂໍ້ຜິດພາດ

ຂໍ້ຜິດພາດແມ່ນ object JSON ທີ່ມີ error ເຊິ່ງເກັບ type ແລະ message. /v1/messages ຫໍ່ມັນຕາມທີ່ SDK Anthropic ຄາດຫວັງ; path ອື່ນທັງໝົດໃຊ້ຮູບຮ່າງ OpenAI.

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

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

• ອ່ານ type ແລະ message. code ແລະ param ມີໃນບາງຂໍ້ຜິດພາດເທົ່ານັ້ນ: ຖືວ່າເປັນທາງເລືອກ. param ເປັນ null ສະເໝີ.
• ຫຼັງຈາກ stream ເລີ່ມແລ້ວ, status ເປັນ 200 ແລ້ວ. ຄວາມລົ້ມເຫຼວຈຶ່ງມາເປັນ error frame ພາຍໃນ stream.
• ທຸກຄຳຕອບຂໍ້ຜິດພາດມີ header x-request-id.

ການຈັດການຂໍ້ຜິດພາດ

ການຄິດເງິນ ແລະ ຍອດເງິນ

• ມີໜຶ່ງຍອດເງິນຕໍ່ບັນຊີ, ແລະ chat ກັບ API ໃຊ້ຮ່ວມກັນ: ໂຄວຕາຂອງແຜນມື້ນີ້ກ່ອນ, ແລ້ວຈຶ່ງເຄຣດິດທີ່ຊື້ເພີ່ມ. API ບໍ່ມີໂຄວຕາຂອງຕົນເອງ.
• ຄຳຮ້ອງຂໍກັນງົບ output ຂອງມັນ (max_tokens, ຄ່າເລີ່ມຕົ້ນ 4,096) ແລ້ວຖືກຄິດເງິນຕາມ tokens ທີ່ໃຊ້ຈິງ, ໃນລາຄາຂອງ model.
• ທຸກຄຳຕອບລາຍງານຈຳນວນ tokens ໃນ usage. ໜ້າ Keys & usage ສະແດງຍອດເງິນ ແລະ ຄ່າໃຊ້ຈ່າຍຂອງແຕ່ລະຄຳຮ້ອງຂໍ.
• ທຸກຄຳຮ້ອງຂໍໄດ້ຮັບການບໍລິການເທົ່າທຽມກັນ. ຂີດຈຳກັດດຽວທີ່ກ່ຽວກັບອັດຕາຄຳຮ້ອງຂໍແມ່ນ flood protection: 120 ຄຳຮ້ອງຂໍຕໍ່ນາທີຕໍ່ບັນຊີ. ຄຳຮ້ອງຂໍທີ່ສົ່ງແບບຂະໜານລໍຖ້າໃນຄິວ.

ຂີດຈຳກັດ ແລະ ຍອດເງິນ Model ແລະ ລາຄາ Keys & usage

ຟີລດ໌ທີ່ຂຶ້ນກັບ model

ທຸກ model ຮັບຄຳຮ້ອງຂໍດຽວກັນ. ບາງຟີລດ໌ມີຜົນສະເພາະບາງ model; ຕາຕະລາງບອກວ່າບ່ອນໃດ. ໜ້າຂອງແຕ່ລະ endpoint ລາຍຊື່ທຸກຟີລດ໌.

Chat Completions

ມາຈາກ SDK ຂອງ OpenAI

• ຕັ້ງ base URL ເປັນ https://api.shannon-ai.com/v1 ແລະ key ເປັນ key Shannon ຂອງທ່ານ. ການເອີ້ນ Chat Completions ແລະ Responses ຈະໃຊ້ໄດ້ກັບ SDK ຕາມທີ່ມັນເປັນ.
• model ຕ້ອງເປັນ id ຂອງ Shannon. ຊື່ model ຂອງຜູ້ໃຫ້ບໍລິການອື່ນ, ເຊັ່ນ gpt-4o, ຖືກຕອບດ້ວຍ 400 ແລະ unknown model.
• Reasoning ມາໃນຟີລດ໌ຂອງມັນເອງ: reasoning_content ຄຽງຄູ່ content, ໃນຂໍ້ຄວາມ ແລະ ໃນ delta ຂອງ stream.
• stream ມີ usage ໃນ chunk ສຸດທ້າຍສະເໝີ, ພ້ອມກັບ finish_reason.
• ການເອີ້ນ tool ໃນ stream ມາເປັນ chunk ດຽວທີ່ມີ string arguments ຄົບຖ້ວນ.
• ຄຳຕອບມີ choice ດຽວ.
• path ຂອງ API OpenAI ທີ່ບໍ່ຢູ່ໃນຕາຕະລາງຂ້າງເທິງ, ເຊັ່ນ /v1/embeddings, ຖືກຕອບດ້ວຍ 404.

ມາຈາກ SDK ຂອງ Anthropic

• ຕັ້ງ base URL ເປັນ https://api.shannon-ai.com, ໂດຍບໍ່ມີ /v1, ແລະ key ເປັນ key Shannon ຂອງທ່ານ. SDK ສົ່ງມັນເປັນ x-api-key.
• model ຕ້ອງເປັນ id ຂອງ Shannon.
• max_tokens ເປັນທາງເລືອກໃນ API ນີ້. ຄ່າເລີ່ມຕົ້ນແມ່ນ 4,096.
• ຄຳຕອບມີ content block ປະເພດ thinking, text ແລະ tool_use. block ທຳອິດບໍ່ແມ່ນຂໍ້ຄວາມສະເໝີໄປ: ເລືອກ block ຕາມ type.
• stop_reason ແມ່ນ end_turn ຫຼື tool_use. stream ຂອງ model Shannon ຍັງຈົບດ້ວຍ max_tokens ໄດ້.
• anthropic-version ແລະ anthropic-beta ຖືກຮັບໄວ້, ດັ່ງນັ້ນ SDK ເຮັດວຽກໂດຍບໍ່ຕ້ອງປ່ຽນ. ຄຳຮ້ອງຂໍບໍ່ຈຳເປັນຕ້ອງມີພວກມັນ.
• ຂໍ້ຜິດພາດໃນ /v1/messages ມີຮູບຮ່າງແບບ Anthropic: {"type": "error", "error": {…}}.

tool ສຳລັບຂຽນໂຄ້ດທີ່ໃຊ້ຮູບແບບເຫຼົ່ານີ້ຖືກຕັ້ງຄ່າແບບດຽວກັນ: base URL, key, ແລະ id ຂອງ Shannon ເປັນ model. ເຄື່ອງມື CLI ສຳລັບຂຽນໂຄ້ດ