Rivya API

สร้างบนเลเยอร์โมเดล multimodal ของ Rivya

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

รูปทรง quickstart

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

catalog แบบ dynamic

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

เครดิตร่วม

เวอร์ชันแรก

Jobs + Chat

การเข้าถึง

API keys

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

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

คำขอ
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": 20,
  "result": null,
  "error": null
}

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

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

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

API สร้างภาพ

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

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

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

API สร้างเสียง

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

wallet เครดิตร่วม

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

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

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

01

สร้าง key

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

02

เลือกโมเดล

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

03

ส่งงาน poll หรือ subscribe

ส่งคำขอ generation แบบ idempotent, poll endpoint งานสาธารณะ, ใช้ webhook ที่ลง signature สำหรับ generation callback หรือส่ง Chat API turn พร้อม SSE streaming แบบเลือกได้

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

scope ชัดเจน ไม่มีสัญญาแฝง

landing page พูดถึงพื้นผิวในอนาคตได้ แต่ copy ของผลิตภัณฑ์ปัจจุบันต้องไม่สื่อว่า API ที่ยังไม่เสร็จ live แล้ว

Chat API

พร้อมใช้งาน

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

Files API

พร้อมใช้งาน

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

webhook ของผู้ใช้

พร้อมใช้งาน

พร้อมใช้งานสำหรับ integration production ที่ต้องการ callback แบบ signed สำหรับงาน generation ที่สำเร็จหรือล้มเหลว

debugger ออนไลน์

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

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

สถานะบัญชี

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

prefix ของ key ที่ active

สร้าง key ก่อน

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

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

ตัวอย่าง mockPublic API แบบ liveไม่มี API key ที่ active

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

วาง key เฉพาะสำหรับคำขอนี้ debugger จะไม่เก็บไว้หลัง refresh

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

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

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

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

สร้าง API keyอ่าน API docs
ตัวอย่าง request
{
  "model": "z-image",
  "prompt": "ภาพถ่ายผลิตภัณฑ์เชิง editorial บนฉาก studio ที่สะอาด",
  "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

อ่าน authentication, request body, response, idempotency, พารามิเตอร์โมเดล และ error code

เปิด docs

การจัดการ API key

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

จัดการ key

debug ออนไลน์

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

ดูตัวอย่าง flow