โมเดล API

ใช้ GET /api/v1/models เพื่อดูรายการโมเดล Rivya พร้อมความพร้อมใช้งานของ Public API

curl https://rivya.ai/api/v1/models

endpoint นี้เป็น public และ read-only โดยคืนชั้นข้อมูลโมเดลสาธารณะชุดเดียวกับที่ API docs และ online debugger ใช้ รวมถึงโมเดลที่ยังเรียกใช้งานได้ไม่ครบทั้งหมด

รูปแบบ Response

response ใช้โครงสร้างนี้:

{
  "object": "list",
  "data": [
    {
      "id": "z-image",
      "display_name": "Z-Image",
      "category": "image",
      "runtime": "async_task",
      "base_credits": 1,
      "billing_type": "FIXED",
      "supported_modes": ["text-to-image"],
      "max_prompt_length": 1000,
      "reference_media": null,
      "params": [],
      "api_status": "available",
      "api_input_status": "available_text",
      "supported_api_inputs": ["text"],
      "requires_files_api": false,
      "requires_upload_for_modes": [],
      "url_input_supported": false,
      "file_kinds": [],
      "chat_capabilities": null,
      "notices": []
    }
  ]
}

ใช้ id เป็นค่า model ใน POST /api/v1/generations สำหรับโมเดล generation แบบ asynchronous สำหรับโมเดล chat ให้ใช้ POST /api/v1/chat/completions และตรวจ chat_capabilities

สถานะ Availability

model reference ใช้ public states เหล่านี้:

• available: มีเส้นทาง generation ผ่าน Public API อย่างน้อยหนึ่งเส้นทางที่พร้อมใช้งาน

• coming_soon: เป็นโมเดล async generation แต่ยังไม่เปิดผ่าน Public API

• studio_only: โมเดลพร้อมใช้งานผ่าน Studio หรือพื้นที่อื่นของผลิตภัณฑ์ แต่ไม่ใช่ Public API v1

field ความพร้อมของ input จะเฉพาะเจาะจงกว่า:

• available_text: request แบบ prompt-based ทดสอบได้โดยตรง

• available_url_input: public URL หรือ scalar params ทดสอบได้โดยตรง

• partial_requires_files: บาง modes เรียกได้โดยไม่ต้อง upload; modes ที่ใช้ reference media ควรใช้ Files API

• requires_files_api: โมเดลพึ่งพา reference media ที่ upload ผ่าน /api/v1/files

ใช้ Files API ก่อนเรียก modes ที่ต้องใช้ reference รูปภาพ วิดีโอ หรือเสียงที่อัปโหลดแล้ว

สำหรับโมเดล chat, chat_capabilities ระบุว่า Chat API รองรับ non-streaming responses, streaming responses, web search, ไฟล์แนบรูปภาพแบบ file_id, thoughts และ reasoning effort หรือไม่

นโยบายจำนวนโมเดล

รายการโมเดลสาธารณะเปลี่ยนได้เมื่อ Rivya เพิ่ม ลบ หรือจำกัดการเข้าถึงโมเดล

อย่าพึ่งจำนวนโมเดลแบบ hard-coded ใน integration ของคุณ ให้อ่าน /api/v1/models หรือ Model API Reference แบบไดนามิกเสมอ

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

• Model API Reference

• สร้างงาน Generation

• Chat API

• คู่มือเลือกโมเดล Rivya

• ความพร้อมใช้งานของโมเดลใน Rivya