Rivya AI

Rivya API

สร้างบนเลเยอร์โมเดลหลายรูปแบบของ Rivya

Rivya API ให้ทีมผลิตภัณฑ์เรียกใช้โมเดล Rivya จากแอปของตนเองผ่าน Public API แบบอิงบัญชี เริ่มจากงานภาพ วิดีโอ และเสียงแบบอะซิงโครนัส เพิ่มรอบสนทนา Chat API พร้อม SSE streaming แบบเลือกได้เมื่อโมเดลรองรับแชต และเก็บการชำระเงินไว้ในกระเป๋าเครดิต Rivya เดียวกัน
อ่านเอกสาร APIสร้าง API key

รูปแบบเริ่มต้นใช้งานด่วน

เลเยอร์โมเดล

แค็ตตาล็อกแบบไดนามิก

การคิดค่าใช้จ่าย

เครดิตร่วม

เวอร์ชันแรก

งาน + Chat

การเข้าถึง

API keys

วิธีเรียกPOST
Endpoint/api/v1/generations

คำขอจริงต้องใช้ Rivya API key และเครดิตบัญชีที่พร้อมใช้งาน ตัวอย่างสาธารณะใช้ secret ตัวอย่างและไม่เรียกโมเดลแบบไม่ระบุตัวตน

คำขอ
curl https://rivya.ai/api/v1/generations \
  -H "Authorization: Bearer rvya_sk_..." \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: demo-job-001" \
  -d '{
    "model": "z-image",
    "prompt": "Editorial product photo on a clean studio set"
  }'
คำตอบ
{
  "id": "task_public_id",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 1,
  "result": null,
  "error": null
}

สิ่งที่จะปล่อยก่อน

เลเยอร์ Public API ที่สอดคล้องกับผลิตภัณฑ์ Rivya

API เป็นส่วนหนึ่งของผลิตภัณฑ์ Rivya โดยใช้ model ID เครดิต และสถานะงานสาธารณะของ Rivya พร้อมเอกสารที่เชื่อมกับแค็ตตาล็อกโมเดล

API สร้างภาพ

ส่งงานภาพพร้อมพรอมต์และพารามิเตอร์โมเดลที่รองรับ จากนั้นตรวจสถานะซ้ำเพื่อรับผลลัพธ์สาธารณะ

API สร้างวิดีโอ

รันงานวิดีโอแบบอะซิงโครนัสด้วยการควบคุมงานและเครดิตชุดเดียวกับที่ Studio ใช้

API สร้างเสียง

ใช้โมเดลเสียงที่เข้าถึงผ่าน API ได้ ภายใต้บัญชี ยอดคงเหลือ และขอบเขตประวัติเดียวกัน

กระเป๋าเครดิตร่วม

การเรียก API และการใช้งาน Studio ดึงจากยอด Rivya เดียวกัน พร้อมเครดิตที่กันไว้และการจัดการเมื่อเกิดความล้มเหลว

เส้นทางเริ่มต้น

จากบัญชีสู่คำขอ API แรก

01

สร้างคีย์

ลงชื่อเข้าใช้ เปิด API Keys ใน Settings สร้างคีย์ที่มีขอบเขตสิทธิ์ และเก็บ secret แบบเต็มทันที

02

เลือกโมเดล

อ่านข้อมูลอ้างอิงโมเดล API หรือเรียก /api/v1/models เพื่อตรวจ model ID, พารามิเตอร์, ความสามารถแชต และความพร้อมของอินพุตก่อนส่งงาน

03

ส่งงาน ตรวจสถานะ หรือสมัครรับผล

ส่งคำขอสร้างงานแบบ idempotent, ตรวจ endpoint งานสาธารณะซ้ำ, ใช้ webhook ที่ลงลายเซ็นสำหรับ callback ของงานสร้าง หรือส่งรอบสนทนา Chat API พร้อม SSE streaming แบบเลือกได้

ขอบเขตเวอร์ชัน

ขอบเขตชัดเจน ไม่มีสัญญาแฝง

หน้านี้แยกความสามารถของ API ที่พร้อมใช้งานออกจากสิ่งที่จะเพิ่มในอนาคตอย่างชัดเจน เพื่อให้คุณวางแผนตามสิ่งที่ใช้งานได้จริงในวันนี้

Chat API

พร้อมใช้งาน

พร้อมใช้งานสำหรับรอบสนทนาแบบ non-streaming และ SSE streaming พร้อมเซสชันที่สร้างผ่าน API เครดิตบัญชี และไฟล์แนบภาพจาก Files API แบบเลือกได้

Files API

พร้อมใช้งาน

พร้อมใช้งานสำหรับอัปโหลดภาพ วิดีโอ และเสียงอ้างอิง ใช้ก่อนสร้างงานเมื่อหน้าโมเดลต้องการ params.referenceMediaItems

webhook ของผู้ใช้

พร้อมใช้งาน

พร้อมใช้งานสำหรับการเชื่อมต่อโปรดักชันที่ต้องการ callback แบบลงลายเซ็นสำหรับงานสร้างที่สำเร็จหรือล้มเหลว

ตัวดีบักออนไลน์

ดูตัวอย่างคำขอ แล้วรันด้วย API key ของคุณเอง

ตัวดีบักเริ่มใน mock mode สำหรับผู้เยี่ยมชมทุกคน ตัวเลือกงานสร้างแสดงโมเดลที่ไม่ใช่แชตซึ่งทดสอบได้โดยไม่ต้องอัปโหลดไฟล์ ส่วนแผง Files ให้ผู้ใช้ที่ลงชื่อเข้าใช้ทดสอบ /api/v1/files ด้วย API key ชั่วคราว ตัวอย่างแชตอยู่ในเอกสาร API

สถานะบัญชี

กำลังตรวจบัญชี

prefix ของคีย์ที่ใช้งานอยู่

สร้างคีย์ก่อน

เครดิตปัจจุบัน

ลงชื่อเข้าใช้เพื่อตรวจ

ตัวอย่าง mockPublic API แบบใช้งานจริงไม่มี API key ที่ใช้งานอยู่

mock mode ไม่เรียกโมเดลและไม่ใช้เครดิต

วางคีย์เฉพาะสำหรับคำขอนี้ ตัวดีบักจะไม่เก็บไว้หลังรีเฟรช

ทดสอบอัปโหลด Files API

อัปโหลดสื่ออ้างอิงผ่าน POST /api/v1/files จากนั้นคัดลอก URL และ duration token ที่ได้กลับมาใส่ใน params.referenceMediaItems สำหรับโมเดลที่รองรับอินพุตอ้างอิง

mock จะไม่อัปโหลดจริงโหมดใช้งานจริงใช้ /api/v1/files

โมเดลที่เลือกควบคุม MIME type ขนาด และกฎระยะเวลาที่อนุญาต การอัปโหลดจริงต้องใช้ API key ชั่วคราวของคุณและอาจเรียกบริการอัปโหลดจริง

สร้าง API keyอ่านเอกสาร API
ตัวอย่างคำขอ
{
  "model": "z-image",
  "prompt": "ภาพถ่ายผลิตภัณฑ์เชิงบรรณาธิการบนฉากสตูดิโอที่สะอาด",
  "params": {
    "aspect_ratio": "1:1"
  }
}
คำตอบ
{
  "id": "mock_task_001",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 1,
  "final_credits": 0,
  "result": null,
  "error": null
}
response จาก Files API
{
  "id": "file_mock_001",
  "object": "file",
  "kind": "image",
  "file_name": "reference.png",
  "mime_type": "image/png",
  "size_bytes": 245760,
  "url": "https://media.example/reference.png",
  "duration_seconds": null,
  "duration_token": null,
  "created_at": "2026-05-11T00:00:00.000Z",
  "expires_at": null
}
params สำหรับ generation
{
  "params": {
    "referenceMediaItems": [
      {
        "url": "https://media.example/reference.png",
        "kind": "image",
        "name": "reference.png",
        "mimeType": "image/png"
      }
    ]
  }
}

สถานะงาน

เครดิตพื้นฐานโดยประมาณ

1

สถานะ

queued

เอกสาร API

อ่านการยืนยันตัวตน request body, response, idempotency, พารามิเตอร์โมเดล และ error code

เปิดเอกสาร

การจัดการ API key

สร้าง คัดลอกครั้งเดียว เพิกถอน และหมุนเวียน API key จากพื้นที่ Settings ที่ป้องกันไว้

จัดการคีย์

ดีบักออนไลน์

ใช้ตัวอย่าง mock ก่อน การดีบักจริงต้องเข้าสู่ระบบ มี API key และเครดิตบัญชี

ดูตัวอย่างขั้นตอน