Senaraikan model API Rivya, fahami ID model, kategori, had prompt, media rujukan, keadaan kesediaan dan pergantungan Files API.

Gunakan GET /api/v1/models untuk menyenaraikan model Rivya bersama kesediaan Public API masing-masing.

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

Endpoint ini awam dan baca sahaja. Ia mengembalikan lapisan model awam yang sama digunakan oleh dokumen API dan penyahpepijat dalam talian, termasuk model yang belum boleh dipanggil sepenuhnya.

Bentuk Respons

Respons menggunakan bentuk ini:

{
  "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": []
    }
  ]
}

Gunakan id sebagai nilai model dalam POST /api/v1/generations untuk model penjanaan tak segerak. Untuk model chat, gunakan POST /api/v1/chat/completions dan semak chat_capabilities.

Keadaan Ketersediaan

Rujukan model menggunakan keadaan awam berikut:

available: sekurang-kurangnya satu laluan penjanaan Public API tersedia
coming_soon: model penjanaan tak segerak, tetapi belum didedahkan melalui Public API pada masa ini
studio_only: model tersedia melalui Studio atau permukaan produk lain, bukan melalui Public API v1

Medan kesediaan input memberikan butiran yang lebih khusus:

available_text: permintaan berasaskan prompt boleh diuji secara langsung
available_url_input: URL awam atau params skalar boleh diuji secara langsung
partial_requires_files: sesetengah mod boleh dipanggil tanpa muat naik; mod media rujukan harus menggunakan Files API
requires_files_api: model bergantung pada media rujukan yang dimuat naik melalui /api/v1/files

Gunakan Files API sebelum memanggil mod yang memerlukan rujukan imej, video atau audio yang dimuat naik.

Untuk model chat, chat_capabilities mendokumenkan sama ada Chat API menyokong respons bukan penstriman, respons penstriman, carian web, lampiran imej file_id, thoughts dan reasoning effort.

Dasar Kiraan Model

Senarai model awam berubah apabila Rivya menambah, membuang atau mengehadkan model.

Jangan bergantung pada kiraan model yang ditetapkan secara keras dalam integrasi anda. Sentiasa baca /api/v1/models atau Rujukan API Model dinamik.

Model API

Bentuk Respons

Keadaan Ketersediaan

Dasar Kiraan Model

Halaman Berkaitan

Jadual kandungan