ภาพรวม Rivya API

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

public API รองรับ asynchronous image, video และ audio generation รวมถึง Chat API turns พร้อม responses แบบ non-streaming หรือ SSE streaming โดยใช้ Rivya model IDs, Rivya account credits, public task IDs สำหรับ generation และ server-side chat sessions สำหรับ Chat API

API ใช้ทำอะไร

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

• ส่ง image, video หรือ audio generation jobs จาก app ของคุณเอง
• ส่ง chat turns แบบ non-streaming หรือ streaming และสนทนาต่อใน chat sessions ที่สร้างผ่าน API
• ให้การคิดค่าใช้จ่ายอยู่ในกระเป๋าเครดิตของบัญชี Rivya เดียวกัน
• poll task status ด้วย public task ID
• ใช้ idempotent retries เพื่อให้ production requests ปลอดภัยขึ้น
• ให้การใช้งาน Studio และ API อยู่ภายใต้ขอบเขตบัญชีเดียวกัน

API คือ product layer ของ Rivya public responses ใช้เฉพาะชื่อ Rivya และ public fields เท่านั้น

ขอบเขต Version ปัจจุบัน

endpoints 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

version ปัจจุบันมี signed webhooks สำหรับผลลัพธ์ asynchronous generation, Chat API และ TypeScript SDK beta พร้อม server-side streaming support

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

generation, status และ credit endpoints ต้องใช้:

Authorization: Bearer rvya_sk_...

สร้างและหมุนเวียน keys จาก การตั้งค่า API Keys อ่าน การยืนยันตัวตน API ก่อนใช้ key ใน production

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

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

generation jobs จะ reserve หรือใช้ credits เมื่อ task เริ่มทำงาน Chat turns จะ reserve credits ก่อนเรียกโมเดล และสรุป final credits จาก token usage เมื่อ assistant message ถูกบันทึก หาก generation หรือ chat turn ล้มเหลวภายใต้กฎความล้มเหลวเดิมของ Rivya การจัดการคืนเครดิตเดียวกันจะถูกใช้

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

เส้นทาง Integration แรก

1. สร้าง API key ใน Settings
2. เรียก โมเดล API เพื่อเลือก public model ID
3. อ่าน Model API Reference สำหรับ parameters ของโมเดล
4. หากโมเดลต้องใช้ reference media ให้อัปโหลดด้วย Files API
5. ส่ง job ด้วย สร้างงาน Generation
6. poll สถานะงาน Generation จน task สำเร็จหรือล้มเหลว หรือ subscribe API Webhooks เพื่อรับ signed completion events
7. สำหรับ chat models ให้ใช้ Chat API แทน generation endpoint ไฟล์แนบรูปภาพของ Chat ต้องอ้างอิงค่า file_id จาก Files API

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

• API Quickstart
• การยืนยันตัวตน API
• Rivya TypeScript SDK
• Model API Reference
• Chat API
• API Webhooks
• ข้อผิดพลาดและขีดจำกัด API