ภาพรวม

Endpoint

ทุก endpoint อยู่ภายใต้ base URL เดียวและให้บริการผ่าน HTTPS

https://api.shannon-ai.com

สาม endpoint ที่สร้างข้อความเข้าถึงโมเดลชุดเดียวกัน เลือกอันที่มีรูปแบบตรงกับที่โค้ดของคุณใช้อยู่แล้ว

พื้นฐานของคำขอ

• body ของทุก POST คือออบเจ็กต์ JSON หนึ่งรายการ ใหญ่ได้ถึง 32 MiB
• ฟิลด์ที่ API ไม่รู้จักจะไม่ทำให้เกิดข้อผิดพลาดและไม่มีผล คำขอที่เขียนสำหรับผู้ให้บริการรายอื่นจะไม่ล้มเหลวเพราะฟิลด์เกิน
• ฟิลด์ที่รู้จักแต่มีชนิด JSON ไม่ถูกต้อง หรือขาดฟิลด์ที่จำเป็น จะได้รับ 422 body ที่ไม่ใช่ JSON ที่ถูกต้องจะได้รับ 400
• model คือหนึ่งใน id ในหน้าโมเดลและราคา ตัวพิมพ์ใหญ่และเล็กไม่มีผล

คำตอบเป็น JSON หรือสตรีมของ server-sent events เมื่อคำขอตั้ง stream เป็น true แต่ละ endpoint ตอบด้วยรูปแบบของตัวเอง ทุกคำตอบมีเฮดเดอร์ x-request-id

สิ่งที่คำขอต้องผ่าน

คำขอจะถูกตรวจตามลำดับที่กำหนดก่อนที่โมเดลจะทำงาน การตรวจแรกที่ไม่ผ่านจะเป็นผู้ตอบ ดังนั้น 401 จึงยังไม่บอกอะไรเกี่ยวกับ body

รูปแบบของข้อผิดพลาด

ข้อผิดพลาดคือออบเจ็กต์ JSON ที่มี error ซึ่งเก็บ type และ message /v1/messages ห่อไว้ตามที่ Anthropic SDK คาดหวัง ส่วนพาธอื่นทุกพาธใช้รูปแบบของ 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 เสมอ
• หลังจากสตรีมเริ่มแล้ว สถานะเป็น 200 ไปแล้ว ความล้มเหลวจะมาถึงเป็นเฟรมข้อผิดพลาดภายในสตรีม
• ทุกคำตอบข้อผิดพลาดมีเฮดเดอร์ x-request-id

การจัดการข้อผิดพลาด

การเรียกเก็บเงินและยอดคงเหลือ

• แต่ละบัญชีมียอดคงเหลือเดียว แชตและ API ใช้ร่วมกัน: โควตาแผนรายวันก่อน แล้วจึงเครดิตที่ซื้อเพิ่ม API ไม่มีโควตาของตัวเอง
• คำขอจะจองงบเอาต์พุต (max_tokens ค่าเริ่มต้น 4,096) แล้วคิดเงินตาม tokens ที่ใช้จริง ในราคาของโมเดล
• ทุกคำตอบรายงานจำนวน tokens ใน usage หน้าคีย์และการใช้งานแสดงยอดคงเหลือและค่าใช้จ่ายของแต่ละคำขอ
• ทุกคำขอได้รับบริการเท่ากัน ขีดจำกัดเดียวของอัตราคำขอคือ flood protection: 120 คำขอต่อนาทีต่อบัญชี คำขอที่ส่งแบบขนานจะรอในคิว

ขีดจำกัดและยอดคงเหลือ โมเดลและราคา คีย์และการใช้งาน

ฟิลด์ที่ขึ้นกับโมเดล

ทุกโมเดลรับคำขอแบบเดียวกัน มีไม่กี่ฟิลด์ที่มีผลกับบางโมเดลเท่านั้น ตารางระบุไว้ว่าโมเดลใด หน้าของแต่ละ endpoint แสดงทุกฟิลด์

Chat Completions

หากมาจาก OpenAI SDK

• ตั้ง base URL เป็น https://api.shannon-ai.com/v1 และตั้งคีย์เป็นคีย์ Shannon ของคุณ จากนั้นการเรียก Chat Completions และ Responses จะทำงานกับ SDK ได้ตามเดิม
• model ต้องเป็น id ของ Shannon ชื่อโมเดลของผู้ให้บริการรายอื่น เช่น gpt-4o จะได้รับ 400 และ unknown model
• การให้เหตุผลมาในฟิลด์ของตัวเอง: reasoning_content ข้าง content ทั้งในข้อความและใน stream delta
• สตรีมจะมี usage ใน chunk สุดท้ายเสมอ พร้อมกับ finish_reason
• การเรียก tool ในสตรีมจะมาถึงเป็น chunk เดียวพร้อมสตริง arguments ที่สมบูรณ์
• คำตอบมีหนึ่ง choice
• พาธของ OpenAI API ที่ไม่อยู่ในตารางด้านบน เช่น /v1/embeddings จะได้รับ 404

หากมาจาก Anthropic SDK

• ตั้ง base URL เป็น https://api.shannon-ai.com โดยไม่มี /v1 และตั้งคีย์เป็นคีย์ Shannon ของคุณ SDK จะส่งเป็น x-api-key
• model ต้องเป็น id ของ Shannon
• max_tokens เป็นตัวเลือกใน API นี้ ค่าเริ่มต้นคือ 4,096
• คำตอบมี content block ชนิด thinking, text และ tool_use บล็อกแรกไม่ได้เป็นข้อความเสมอไป: ให้เลือกบล็อกตาม type
• stop_reason เป็น end_turn หรือ tool_use สตรีมของโมเดล Shannon อาจจบด้วย max_tokens ได้เช่นกัน
• รับ anthropic-version และ anthropic-beta ไว้ จึงใช้ SDK ได้โดยไม่ต้องแก้ แต่คำขอไม่จำเป็นต้องมี
• ข้อผิดพลาดบน /v1/messages มีรูปแบบของ Anthropic: {"type": "error", "error": {…}}

เครื่องมือเขียนโค้ดที่ใช้รูปแบบเหล่านี้ตั้งค่าแบบเดียวกัน: base URL คีย์ และ id ของ Shannon เป็นโมเดล เครื่องมือเขียนโค้ดแบบ CLI