模型 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
提示词上限
1000 字符
请求字段
模型 ID 放在顶层字段。模型专属控制项放入 params。
| Key | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| model | string | 是 | z-image | 使用 z-image 作为 API 模型 ID。 |
| prompt | string | 是 | - | 这个模型最多 1000 个字符。 |
| params | object | 否 | - | 模型专属参数对象。可用 key 见下方参数表。 |
| 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"
}
}创建响应
创建接口会返回公开任务 ID。继续轮询状态接口，直到任务成功或失败。
{
"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
创建接口会返回公开任务 ID。继续轮询状态接口，直到任务成功或失败。