cicora.ai
cicora.ai / เอกสารอ้างอิงการเชื่อมต่อ

ข้อกำหนด API

เอกสารอ้างอิงสำหรับการเชื่อมต่อเวิร์กโฟลว์ข้อความ เอเจนต์ สื่อ และการค้นคืนข้อมูล

SDK รูปแบบ OpenAI และ curlhttps://cicora.ai/api/v1
Messages SDK และ Claude Codehttps://cicora.ai/api

เอกสารอ้างอิงการเชื่อมต่อ: เลือกพารามิเตอร์และความสามารถที่ใช้ได้จากการตั้งค่า API ของบัญชีและแค็ตตาล็อกโมเดลสำหรับสภาพแวดล้อมของคุณ

ส่งคำขอแรก

เริ่มต้นใช้งาน

POST /chat/completionsเริ่มต้นอย่างรวดเร็ว

ส่งคำขอแรก เลือกโมเดลจากแค็ตตาล็อก และเก็บตัวระบุคำขอไว้สำหรับการวินิจฉัย

Authorization: Bearerการยืนยันตัวตน

ส่งคีย์ API ในส่วนหัว Bearer และแยกข้อมูลรับรองสำหรับการใช้งานจริงออกจากข้อมูลรับรองสำหรับการพัฒนา

URL พื้นฐานของ OpenAI และ MessagesSDK และไคลเอนต์ HTTP

ใช้ URL พื้นฐานต่างกันสำหรับไคลเอนต์รูปแบบ OpenAI และ Messages เพราะทั้งสองมุ่งไปยังข้อกำหนด API เดียวกันแต่ประกอบเส้นทางต่างกัน

URL พื้นฐานของไคลเอนต์ที่เข้ากันได้CLI และการเชื่อมต่อ

กำหนดค่าไคลเอนต์ด้วยคีย์ โมเดล และ URL พื้นฐานที่ตรงกับโปรโตคอล โดยเก็บข้อมูลลับไว้ในสภาพแวดล้อม

คำถามที่พบบ่อยเกี่ยวกับการเชื่อมต่อคำถามที่พบบ่อยสำหรับนักพัฒนา

คำตอบเชิงปฏิบัติแบบสั้นเกี่ยวกับคีย์ URL พื้นฐาน โมเดล ต้นทุน และการวินิจฉัยการเชื่อมต่อ

บัญชีและแค็ตตาล็อก

GET /modelsโมเดลและแค็ตตาล็อก

สร้างการเลือกโมเดลจากข้อมูลแค็ตตาล็อก แทนรายการที่เขียนตายตัวในแอปพลิเคชันของคุณ

การตั้งค่า API ของบัญชีทีมและคีย์ API

แยกคีย์ เจ้าของ งบประมาณ และการติดตามการใช้งานตามแต่ละแอปพลิเคชันและพื้นที่ทำงาน

ขีดจำกัดอัตราคำขอและเครดิตขีดจำกัด

ถือว่าขีดจำกัดของคีย์ องค์กร โมเดล และการกำหนดเส้นทางเป็นส่วนหนึ่งของเวิร์กโฟลว์ผู้ใช้

ข้อมูลเมตาต่อการตอบกลับการใช้งานและต้นทุน

เชื่อมโยงข้อมูลเมตาของการตอบกลับและบันทึกคำขอของคุณเข้ากับการดำเนินการจริงของผู้ใช้

การควบคุมข้อมูลคำขอข้อมูลและความเป็นส่วนตัว

ลดข้อมูลที่ส่ง แยกตัวระบุผู้ใช้ปลายทางออกจากเนื้อหา และควบคุมการเก็บรักษาในผลิตภัณฑ์ของคุณ

ข้อความและเอเจนต์

POST /chat/completionsChat Completions

สร้างการสนทนาหลายรอบในรูปแบบ messages ที่คุ้นเคย และเลือกโมเดลสำหรับแต่ละคำขอ

POST /v1/messagesMessages API

ใช้รูปแบบ Messages สำหรับการสนทนา โดยมีคำสั่งระบบระดับบนสุดและขีดจำกัดเอาต์พุตที่ระบุชัดเจน

POST /responsesResponses API

ใช้ออบเจ็กต์อินพุตเดียวเมื่อแอปพลิเคชันของคุณได้ประโยชน์จากการจัดการรายการเอาต์พุตและการดำเนินการในโมเดลข้อมูลเดียว

POST /chat/completions · stream: trueการสตรีม

รับโทเค็นและเดลตาที่มีโครงสร้างผ่าน SSE โดยไม่ต้องรอการตอบกลับทั้งหมด

POST /chat/completions · toolsเครื่องมือและการเรียกใช้ฟังก์ชัน

อธิบายฟังก์ชันด้วย JSON Schema ดำเนินการเรียกใช้ในแอปพลิเคชันของคุณ และส่งผลลัพธ์กลับไปยังการสนทนา

POST /chat/completions · response_formatเอาต์พุตที่มีโครงสร้าง

ขอออบเจ็กต์ JSON หรือ JSON Schema เมื่อซอฟต์แวร์เป็นผู้ใช้ผลตอบกลับแทนบุคคล

POST /chat/completions · reasoningการให้เหตุผล

กำหนดระดับความพยายามในการให้เหตุผลต่อคำขอ เฉพาะกับโมเดลที่ประกาศว่ารองรับความสามารถนี้

POST /chat/completions · providerการกำหนดเส้นทาง

ระบุความต้องการด้านการดำเนินการไว้ในค่ากำหนดการเลือกผู้ให้บริการ และเก็บผลที่เกิดขึ้นจริงไว้เพื่อการสังเกตการณ์

POST /chat/completions · cache_controlการแคชบริบท

แยกบริบทที่ใช้ซ้ำ เพื่อให้ไคลเอนต์ใช้การแคชที่เข้ากันได้เมื่อโมเดลที่เลือกรองรับ

POST /chat/completions · web_searchการค้นหาเว็บ

ค้นคืนแหล่งข้อมูลล่าสุดผ่านฟังก์ชัน `web_search` ที่ไคลเอนต์ดำเนินการ และแยกลิงก์ออกจากข้อความที่สร้าง

สื่อและการค้นคืนข้อมูล

POST /filesไฟล์และไฟล์แนบ

อัปโหลดไฟล์ผ่านการดำเนินการเฉพาะ เก็บรหัสไว้ และส่งข้อมูลอ้างอิงในคำขอที่เข้ากันได้ภายหลัง

POST /imagesภาพ

สร้างภาพผ่านเส้นทางเดียวและเลือกพารามิเตอร์จากความสามารถของโมเดลที่เลือก

POST /videosวิดีโอ

เริ่มสร้างวิดีโอเป็นงานแบบอะซิงโครนัส เก็บรหัสงานไว้ และแยกการสร้างออกจากการอ่านผลลัพธ์

POST /audio/speech · POST /audio/transcriptionsเสียง

ใช้การดำเนินการแยกกันสำหรับการสังเคราะห์เสียงพูด การถอดเสียง และอินพุตเสียงที่ส่งให้โมเดล

POST /embeddingsเวกเตอร์ฝังตัว

แปลงข้อความหรืออินพุตที่รองรับเป็นเวกเตอร์สำหรับการค้นหา การจัดกลุ่ม และการแนะนำ

POST /rerankจัดอันดับใหม่

จัดลำดับตัวเลือกชุดเล็กใหม่เทียบกับคิวรี เพื่อเพิ่มความแม่นยำของการค้นคืนขั้นสุดท้าย

การทำงานพร้อมกันที่ไคลเอนต์ควบคุมการดำเนินการแบบแบตช์

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

การเชื่อมต่อและความน่าเชื่อถือ