curl --request POST 'https://api.voicecheap.ai/v1/actions/thumbnails_list' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"limit":20}'
const input = {
limit: 20,
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/thumbnails_list', {
method: 'POST',
headers: {
'x-api-key': process.env.VOICECHEAP_API_KEY,
'Content-Type': 'application/json',
},
body: JSON.stringify(input),
});
const body = await response.json();
if (!response.ok) throw new Error(body.code + ': ' + body.message);
console.log(body);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/thumbnails_list",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"limit": 20},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"items": [
{
"generationId": "109c61cb35dbdc01a94aabb3b1a128519ed1f8823800a7a327b9d8d8c2c0e10b",
"status": "completed",
"width": 1280,
"height": 720,
"referenceImageCount": 1,
"createdAt": 1792144800000,
"updatedAt": 1792144800000,
"expiresAt": 1792749600000
}
],
"nextCursor": null
}
}
缩略图
列出已生成的缩略图
按从新到旧的顺序列出已连接账户的缩略图,包括从公开工具认领的预览。包含状态、尺寸和过期时间;使用 nextCursor 获取下一页。
POST
/
v1
/
actions
/
thumbnails_list
curl --request POST 'https://api.voicecheap.ai/v1/actions/thumbnails_list' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"limit":20}'
const input = {
limit: 20,
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/thumbnails_list', {
method: 'POST',
headers: {
'x-api-key': process.env.VOICECHEAP_API_KEY,
'Content-Type': 'application/json',
},
body: JSON.stringify(input),
});
const body = await response.json();
if (!response.ok) throw new Error(body.code + ': ' + body.message);
console.log(body);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/thumbnails_list",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"limit": 20},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"items": [
{
"generationId": "109c61cb35dbdc01a94aabb3b1a128519ed1f8823800a7a327b9d8d8c2c0e10b",
"status": "completed",
"width": 1280,
"height": 720,
"referenceImageCount": 1,
"createdAt": 1792144800000,
"updatedAt": 1792144800000,
"expiresAt": 1792749600000
}
],
"nextCursor": null
}
}
按从新到旧的顺序列出已连接账户的缩略图,包括从公开工具认领的预览。包含状态、尺寸和过期时间;使用 nextCursor 获取下一页。
所需权限:
POST https://api.voicecheap.ai/v1/actions/thumbnails_list
身份验证和权限
string
必填
在此请求头中发送 VoiceCheap API 密钥。也支持通过 Authorization: Bearer 发送同一 API 密钥。OAuth 访问令牌仅适用于 MCP,此 REST 端点不接受 OAuth
访问令牌。
thumbnails:read.
需要有效的付费订阅。权限不会改变团队角色、资源归属、媒体额度或套餐限制。
参数
integer
整数值。最小值: 1. 最大值: 100. 默认值: 20.
string
上一页返回的 nextCursor。最小长度: 1. 最大长度: 512.
完整输入架构
完整输入架构
以下 JSON Schema 保留了发现接口公开的确切字段名、嵌套类型、默认值、范围和可接受值。其他跨字段规则列于操作说明中。
{
"type": "object",
"properties": {
"limit": {
"default": 20,
"type": "integer",
"minimum": 1,
"maximum": 100
},
"cursor": {
"description": "The nextCursor from the previous page.",
"type": "string",
"minLength": 1,
"maxLength": 512
}
},
"additionalProperties": false
}
请求示例
请将示例资源标识符和媒体键替换为账户返回的值。重试同一次修改操作时,请保持请求标识符不变。curl --request POST 'https://api.voicecheap.ai/v1/actions/thumbnails_list' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"limit":20}'
const input = {
limit: 20,
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/thumbnails_list', {
method: 'POST',
headers: {
'x-api-key': process.env.VOICECHEAP_API_KEY,
'Content-Type': 'application/json',
},
body: JSON.stringify(input),
});
const body = await response.json();
if (!response.ok) throw new Error(body.code + ': ' + body.message);
console.log(body);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/thumbnails_list",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"limit": 20},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
响应
首次执行成功时返回 HTTP 200,操作结果位于 data 下。重放请求时可能改为返回已保存的请求状态。示例展示了一种支持的响应,并未包含所有可选字段。 属于已连接用户的一页缩略图元数据,按从新到旧排序。还包括该账户先前认领的公开工具缩略图。{
"data": {
"items": [
{
"generationId": "109c61cb35dbdc01a94aabb3b1a128519ed1f8823800a7a327b9d8d8c2c0e10b",
"status": "completed",
"width": 1280,
"height": 720,
"referenceImageCount": 1,
"createdAt": 1792144800000,
"updatedAt": 1792144800000,
"expiresAt": 1792749600000
}
],
"nextCursor": null
}
}
结果字段
| 字段 | 说明 |
|---|---|
data.items | 缩略图元数据对象数组。 |
data.items[].generationId | 原样传给 thumbnails_get 或 thumbnails_download 的标识符。 |
data.items[].status | completed、expired 或 deleted。已删除的记录即使超过过期时间也仍为 deleted。 |
data.items[].width | 输出宽度,单位为像素:1280。 |
data.items[].height | 输出高度(像素):720。 |
data.items[].referenceImageCount | 使用的参考图片数量:0 至 3。 |
data.items[].createdAt | 创建时间,以 Unix 毫秒表示。 |
data.items[].updatedAt | 上次更新时间,采用 Unix 毫秒时间戳。 |
data.items[].expiresAt | 生成的缩略图在此时间之后无法下载,采用 Unix 毫秒时间戳。 |
data.nextCursor | 不透明的下一页游标;没有更多页面时为 null。 |
操作说明
- 需要 thumbnails:read 权限。limit 默认为 20,必须是 1 至 100 的整数。cursor 为可选项,最长为 512 个字符。
- 将 nextCursor 原样作为 cursor 传入以获取下一页。到达末尾时 nextCursor 为 null;结果按创建时间和生成标识符降序排列。
- 此操作使用已连接用户自己的生成内容和上传文件,包括凭据在团队上下文中连接时。
- 缩略图元数据报告 completed、expired 或 deleted。此历史记录不会公开待处理生成记录;请轮询 action_request_get 跟踪缩略图生成请求。
- 请以每条记录的 expiresAt 为准,包括已领取的公开工具结果。可见记录如果已过期或被删除,也无法下载。历史记录为空时返回 items: [] 和 nextCursor: null。
- 使用 thumbnails_download 获取 WebP 数据;此历史记录不包含嵌入图片或预览 URL。
用量
每次成功调用消耗一次月度 API/MCP 调用额度。媒体额度和操作本身的生成限额也适用。错误
| HTTP 状态 | 代码 | 含义或恢复方式 |
|---|---|---|
| 400 | CREDENTIAL_IN_QUERY | 凭证通过 access_token 或 api_key 查询参数提供。请在标头中发送凭证。 |
| 400 | INVALID_CURSOR | cursor 不是有效的历史记录游标;请使用上一页返回的 nextCursor。 |
| 400 | VALIDATION_ERROR | 某个参数缺失、值不受支持、超出限额,或不属于严格输入架构。 |
| 401 | API_KEY_EXPIRED | API 密钥已过期。 |
| 401 | INVALID_API_KEY | 请提供有效且未过期的 API 密钥。 |
| 401 | INVALID_CREDENTIAL | Authorization 标头格式错误或与 x-api-key 冲突。 |
| 401 | MISSING_CREDENTIAL | 未提供可用的请求头凭据,或其长度超过 4096 个字符。 |
| 401 | USER_NOT_FOUND | 该凭据对应的账户已不存在。 |
| 403 | AMBIGUOUS_TEAM_API_KEY | 此凭据对应的用户属于多个团队,因此计费上下文不明确。 |
| 403 | INSUFFICIENT_SCOPE | 请授予全部所需权限,或选择其他凭据。 |
| 403 | INTEGRATION_PLAN_UNSUPPORTED | 无法验证该账户的集成限制。 |
| 403 | SUBSCRIPTION_REQUIRED | 请使用有效的付费订阅。 |
| 403 | TEAM_OWNER_NOT_FOUND | 找不到实际生效的团队所有者账户。 |
| 429 | INTEGRATION_MONTHLY_LIMIT_REACHED | 请等待月度额度重置,或更改套餐。 |
| 429 | INTEGRATION_RATE_LIMIT_REACHED | 如果提供了 Retry-After,请等待其指定的时间,并采用退避重试。 |
| 500 | INTERNAL_ERROR | 在决定是否重试修改操作前,请检查已保存的请求状态和资源历史记录。 |
| 503 | SERVER_RESTARTING | 服务器正在重启。请稍后重试;对于修改操作,请保持请求标识符不变。 |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["thumbnails:read"]
}
}
此页面对您有帮助吗?

