ใช้ Rivya API v1 เพื่อเรียก การสร้าง และ การสนทนา โมเดล ของ Rivya จากผลิตภัณฑ์ของคุณเองด้วย API คีย์, บัญชี เครดิต และ SSE การสตรีม แบบเลือกใช้ได้

Rivya API v1 คือสัญญาสำหรับนักพัฒนาในการเรียกความสามารถของโมเดล Rivya ที่รองรับจากผลิตภัณฑ์ของคุณเอง โดย ระบบที่นำไปใช้งาน ต้องเปิด สาธารณะ API และบัญชีของคุณต้องมีสิทธิ์ใช้

สัญญาที่ระบบรองรับครอบคลุมงานสร้างภาพ วิดีโอ และเสียงแบบอะซิงโครนัส รวมถึงรอบ Chat API ที่ตอบได้ทั้งแบบไม่สตรีมและสตรีมผ่าน SSE โดยใช้รหัสโมเดลของ Rivya เครดิตบัญชี รหัสงานสาธารณะ และเซสชันแชตฝั่งเซิร์ฟเวอร์ การมีเอกสารของเส้นทาง API ไม่ได้หมายความว่าทุกสภาพแวดล้อม บัญชี หรือโมเดลในแค็ตตาล็อกจะเรียกใช้ได้ ต้องยืนยันสิทธิ์และความพร้อมของโมเดลในระบบจริงก่อนเชื่อมต่อ

API ใช้ทำอะไร

ใช้ API เมื่อคุณต้องการ:

ส่ง ภาพ, วิดีโอ หรือ เสียง การสร้าง งาน จาก แอป ของคุณเอง
ส่ง การสนทนา รอบสนทนา แบบ แบบไม่สตรีม หรือ การสตรีม และสนทนาต่อใน การสนทนา เซสชัน ที่สร้างผ่าน API
ให้การคิดค่าใช้จ่ายอยู่ในกระเป๋าเครดิตของบัญชี Rivya เดียวกัน
ตรวจสถานะซ้ำ งาน สถานะ ด้วย สาธารณะ งาน ID
ใช้กลไกป้องกันคำขอซ้ำและการลองใหม่ เพื่อให้คำขอในระบบจริงปลอดภัยขึ้น
ให้การใช้งาน Studio และ API อยู่ภายใต้ขอบเขตบัญชีเดียวกัน

API คือ ผลิตภัณฑ์ ชั้นงาน ของ Rivya สาธารณะ คำตอบ ใช้เฉพาะชื่อ Rivya และ สาธารณะ ช่องข้อมูล เท่านั้น

ขอบเขต เวอร์ชัน ปัจจุบัน

ปลายทาง v1 ที่ระบบรองรับ ได้แก่:

GET /api/v1/models
POST /api/v1/generations
POST /api/v1/files
GET /api/v1/files/{fileId}
POST /api/v1/chat/completions
GET /api/v1/chat/sessions
GET /api/v1/chat/sessions/{sessionId}
GET /api/v1/generations/{taskId}
GET /api/v1/credits
GET /api/v1/webhooks
POST /api/v1/webhooks
GET /api/v1/webhook-events
GET /api/v1/openapi.json

สัญญาปัจจุบันมีเว็บฮุกที่ลงลายเซ็นสำหรับผลลัพธ์การสร้างแบบไม่ต้องรอ, API แชต และ TypeScript SDK รุ่นทดสอบ พร้อมรองรับการสตรีมจากฝั่งเซิร์ฟเวอร์ การใช้เว็บฮุกต้องให้ระบบเปิดทั้งคุณสมบัติเหตุการณ์เว็บฮุกและ Public API

การยืนยันตัวตน

ปลายทางการสร้าง สถานะ และเครดิตต้องใช้:

Authorization: Bearer rvya_sk_...

สร้างและหมุนเวียน คีย์ จาก การตั้งค่า API คีย์ อ่าน การยืนยันตัวตน API ก่อนใช้ คีย์ ใน การผลิต

โมเดลการคิดค่าบริการ

API การเรียก ใช้เครดิตบัญชี Rivya ชุดเดียวกับ Studio

งานสร้างจะกันหรือใช้เครดิตเมื่อเริ่มทำงาน ส่วนรอบสนทนาจะกันเครดิตก่อนเรียกโมเดล และสรุปเครดิตจริงจากจำนวนโทเคนเมื่อบันทึกข้อความตอบกลับ หากงานสร้างหรือรอบสนทนาล้มเหลวภายใต้กฎเดิมของ Rivya ระบบจะใช้กระบวนการคืนเครดิตเดียวกัน

อ่าน เครดิต API และ เครดิตและการเรียกเก็บเงินใน Rivya สำหรับโมเดลกระเป๋าเครดิตที่ผู้ใช้เห็น

เส้นทาง การเชื่อมต่อ แรก

สร้าง API คีย์ ใน การตั้งค่า
เรียก โมเดล API เพื่อเลือก สาธารณะ โมเดล ID
อ่าน โมเดล API ข้อมูลอ้างอิง สำหรับ พารามิเตอร์ ของโมเดล
หากโมเดลต้องใช้ ข้อมูลอ้างอิง สื่อ ให้อัปโหลดด้วย ไฟล์ API
ส่ง งาน ด้วย สร้างงาน การสร้าง
ตรวจ สถานะงานสร้าง ซ้ำจนงานสำเร็จหรือล้มเหลว หากระบบและบัญชีเปิดใช้เว็บฮุก จึงสมัครรับเหตุการณ์ที่ลงลายเซ็นผ่าน API เว็บฮุก
สำหรับ การสนทนา โมเดล ให้ใช้ การสนทนา API แทน การสร้าง จุดเชื่อมต่อ ไฟล์แนบรูปภาพของ การสนทนา ต้องอ้างอิงค่า file_id จาก ไฟล์ API

ภาพรวม Rivya API

API ใช้ทำอะไร

ขอบเขต เวอร์ชัน ปัจจุบัน

การยืนยันตัวตน

โมเดลการคิดค่าบริการ

เส้นทาง การเชื่อมต่อ แรก

หน้าที่เกี่ยวข้อง

สารบัญ