API 参考 / 生成任务
列出生成任务
listGenerations
GET/v1/generations
下面的接口说明为英文原文。
鉴权
在请求头带上项目 Key,例如 Authorization: Bearer $VIZO_API_KEY。Key 只放在服务端。
查询参数
| 字段 | 说明 |
|---|---|
| limitinteger可选 | 每页条数。 最小 1, 最大 100, 默认 50 |
| client_referencestring可选 | 你自己的请求编号。 最多 256 个字符 |
| cursorstring可选 | 上一页返回的游标。 最多 64 个字符 |
响应
200 OK
| 字段 | 说明 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| entriesobject[], 可为 null必填 | entries 的字段
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| next_cursorstring可选 | 作为 cursor 传入以读取下一页。最后一页为空。 |
错误
所有错误使用同一种响应体。联系支持时请附上 request_id。
错误响应体
| 字段 | 说明 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| errorobject必填 | 错误详情。 error 的字段
|
| 状态码 | 含义与处理 |
|---|---|
| 401 | Key 缺失、格式错误、已过期或已撤销。在服务端更正 Key 后继续。 |
| 402 | 可用 Credits 不足以支付这次请求。充值并等待到账后,再查询余额。 |
| 403 | Key 权限、邮箱验证、预算上限或账户限制阻止了操作。检查 Key 类型、权限和项目预算。 |
| 404 | 模型或资源不存在,或不在当前项目范围内。确认项目、ID 和模型是否已开通。 |
| 409 | 请求与当前状态冲突。重新读取资源,再决定是否重新发送。 |
| 422 | 字段或取值无效。对照字段表和模型页修改请求。 |
| 429 | 请求过于频繁,没有创建任务。等到 Retry-After 指定的时间后再发送。 |
| 500 | 服务端出错,任务可能已经受理。不要直接重发,先查看近期任务。 |
| 503 | 服务暂时不可用。创建请求要先查看近期任务,确认没有受理,再重新提交。 |
请求示例
cURL
curl "https://api.vizoapi.com/v1/generations?limit=20" \
-H "Authorization: Bearer $VIZO_API_KEY"Python
import os, requests
res = requests.get(
"https://api.vizoapi.com/v1/generations?limit=20",
headers={"Authorization": f"Bearer {os.environ['VIZO_API_KEY']}"},
timeout=60,
)
print(res.status_code, res.json())Node.js
const res = await fetch("https://api.vizoapi.com/v1/generations?limit=20", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.VIZO_API_KEY}`,
},
});
console.log(res.status, await res.json());响应 200
{
"entries": [
{
"allowed_actions": [
"cancel"
],
"billing_status": "held",
"closed_at": null,
"customer_resolution_deadline": "2026-11-03T08:00:12Z",
"delivery_status": "pending",
"error": null,
"execution_status": "queued",
"id": "gen_01JD8Z5QW3XR",
"late_result_available": false,
"metadata": {
"client_reference": "order-1042"
},
"price": {
"charged": "0.000",
"price_version": "p3",
"quoted": "1400.000",
"reserved": "1400.000",
"unit": "credit"
},
"result": null,
"status": "queued",
"version": 1
}
],
"next_cursor": ""
}响应 401
{
"error": {
"code": "invalid_credentials",
"message": "API key is missing, malformed, expired or revoked.",
"retryable": false,
"request_id": "9f2c41d07ab3e5c8"
}
}响应 402
{
"error": {
"code": "insufficient_balance",
"message": "Available credits cannot cover the hold.",
"retryable": false,
"request_id": "9f2c41d07ab3e5c8"
}
}响应 403
{
"error": {
"code": "scope_denied",
"message": "The key does not allow this operation for this project.",
"retryable": false,
"request_id": "9f2c41d07ab3e5c8"
}
}响应 404
{
"error": {
"code": "resource_not_found",
"message": "The resource is not available to this project.",
"retryable": false,
"request_id": "9f2c41d07ab3e5c8"
}
}响应 409
{
"error": {
"code": "conflict",
"message": "The request conflicts with the current state of the resource.",
"retryable": false,
"request_id": "9f2c41d07ab3e5c8"
}
}响应 422
{
"error": {
"code": "invalid_input",
"message": "Input does not match the published schema.",
"retryable": false,
"request_id": "9f2c41d07ab3e5c8"
}
}响应 429
{
"error": {
"code": "rate_limited",
"message": "Too many requests. Check Retry-After.",
"retryable": true,
"request_id": "9f2c41d07ab3e5c8"
}
}响应 500
{
"error": {
"code": "request_failed",
"message": "The request failed. Check recent generations before submitting again.",
"retryable": false,
"request_id": "9f2c41d07ab3e5c8"
}
}响应 503
{
"error": {
"code": "temporarily_unavailable",
"message": "Service is temporarily unavailable.",
"retryable": true,
"request_id": "9f2c41d07ab3e5c8"
}
}