模型 API 接入文件
Z-Image API 接入文件
透過 Rivya Public API v1 呼叫 Z-Image，包含模型 ID z-image、輸入類型、參數、Files API 規則、點數和回應範例。
API 可呼叫文字輸入可用圖片
API 模型 ID
z-image
輸入類型
text
Files API
最小請求不需要
基礎點數
1
能力類型
圖片
計費方式
FIXED
Prompt 上限
1000 字元
請求欄位
模型 ID 放在頂層欄位。模型專屬控制項放入 params。
| Key | 類型 | 必填 | 預設值 | 說明 |
|---|---|---|---|---|
| model | string | 是 | z-image | 使用 z-image 作為 API 模型 ID。 |
| prompt | string | 是 | - | 這個模型最多 1000 個字元。 |
| params | object | 否 | - | 模型專屬參數物件。可用 keys 請見下方參數表。 |
| client_request_id | string | 否 | - | 可選的用戶端請求 ID，方便你在自己的系統中追蹤請求。 |
模型參數
| Key | 類型 | 必填 | 預設值 | 範圍 | 選項 | 說明 |
|---|---|---|---|---|---|---|
| aspect_ratio | select | 否 | 1:1 | - | 1:1, 4:3, 3:4, 16:9, 9:16 | 長寬比 |
最小請求
{
"model": "z-image",
"prompt": "A clean editorial product image on a soft studio background",
"params": {
"aspect_ratio": "1:1"
}
}建立回應
建立 endpoint 會回傳公開 task id。繼續輪詢狀態 endpoint，直到任務成功或失敗。
{
"id": "task_z_image_example",
"status": "queued",
"model": "z-image",
"reserved_credits": 1,
"final_credits": 0,
"created_at": "2026-05-11T00:00:00.000Z",
"updated_at": "2026-05-11T00:00:00.000Z",
"result": null,
"error": null
}常見錯誤
validation_failed, insufficient_credits, idempotency_conflict, rate_limited, not_found
建立 endpoint 會回傳公開 task id。繼續輪詢狀態 endpoint，直到任務成功或失敗。