> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.voicecheap.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# 获取缩略图生成信息

> 获取归属于已连接账户的缩略图的状态、尺寸和过期时间。

获取归属于已连接账户的缩略图的状态、尺寸和过期时间。

```http theme={null}
POST https://api.voicecheap.ai/v1/actions/thumbnails_get
```

## 身份验证和权限

<ParamField header="x-api-key" type="string" required>
  在此请求头中发送 VoiceCheap API 密钥。也支持通过 Authorization: Bearer 发送同一 API 密钥。OAuth 访问令牌仅适用于 MCP，此 REST 端点不接受 OAuth
  访问令牌。
</ParamField>

所需权限: `thumbnails:read`.

需要有效的付费订阅。权限不会改变团队角色、资源归属、媒体额度或套餐限制。

## 参数

<ParamField body="generationId" type="string" required>
  生成或历史记录操作返回的生成 ID。

  匹配模式: `^[A-Za-z0-9_-]{1,128}$`.
</ParamField>

<Accordion title="完整输入架构">
  以下 JSON Schema 保留了发现接口公开的确切字段名、嵌套类型、默认值、范围和可接受值。其他跨字段规则列于操作说明中。

  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "generationId": {
        "type": "string",
        "pattern": "^[A-Za-z0-9_-]{1,128}$",
        "description": "Generation ID returned by a generation or history action."
      }
    },
    "required": ["generationId"],
    "additionalProperties": false
  }
  ```
</Accordion>

## 请求示例

请将示例资源标识符和媒体键替换为账户返回的值。重试同一次修改操作时，请保持请求标识符不变。

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST 'https://api.voicecheap.ai/v1/actions/thumbnails_get' \
    --header "x-api-key: $VOICECHEAP_API_KEY" \
    --header 'Content-Type: application/json' \
    --data '{"generationId":"109c61cb35dbdc01a94aabb3b1a128519ed1f8823800a7a327b9d8d8c2c0e10b"}'
  ```

  ```javascript JavaScript theme={null}
  const input = {
    generationId: '109c61cb35dbdc01a94aabb3b1a128519ed1f8823800a7a327b9d8d8c2c0e10b',
  };
  const response = await fetch('https://api.voicecheap.ai/v1/actions/thumbnails_get', {
    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);
  ```

  ```python Python theme={null}
  import os
  import requests

  response = requests.post(
      "https://api.voicecheap.ai/v1/actions/thumbnails_get",
      headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
      json={"generationId": "109c61cb35dbdc01a94aabb3b1a128519ed1f8823800a7a327b9d8d8c2c0e10b"},
      timeout=120,
  )
  body = response.json()
  if not response.ok:
      raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
  print(body)
  ```
</RequestExample>

## 响应

首次执行成功时返回 HTTP 200，操作结果位于 data 下。重放请求时可能改为返回已保存的请求状态。示例展示了一种支持的响应，并未包含所有可选字段。

已连接用户的缩略图元数据，包含尺寸、引用次数、状态和到期时间。已认领的公共工具缩略图也可获取。

<ResponseExample>
  ```json HTTP 200 theme={null}
  {
    "data": {
      "generationId": "109c61cb35dbdc01a94aabb3b1a128519ed1f8823800a7a327b9d8d8c2c0e10b",
      "status": "completed",
      "width": 1280,
      "height": 720,
      "referenceImageCount": 1,
      "createdAt": 1792144800000,
      "updatedAt": 1792144800000,
      "expiresAt": 1792749600000
    }
  }
  ```
</ResponseExample>

## 结果字段

| 字段 | 说明 |
| - | - |
| `data.generationId` | 原样传给 thumbnails\_get 或 thumbnails\_download 的标识符。 |
| `data.status` | completed、expired 或 deleted。已删除的记录即使超过过期时间也仍为 deleted。 |
| `data.width` | 输出宽度，单位为像素：1280。 |
| `data.height` | 输出高度（像素）：720。 |
| `data.referenceImageCount` | 使用的参考图片数量：0 至 3。 |
| `data.createdAt` | 创建时间，以 Unix 毫秒表示。 |
| `data.updatedAt` | 上次更新时间，采用 Unix 毫秒时间戳。 |
| `data.expiresAt` | 生成的缩略图在此时间之后无法下载，采用 Unix 毫秒时间戳。 |

## 操作说明

* 需要 thumbnails:read。generationId 须包含 1–128 个 ASCII 字母、数字、下划线或连字符。
* 此操作使用已连接用户自己的生成内容和上传文件，包括凭据在团队上下文中连接时。
* 元数据报告 completed、expired 或 deleted；此操作不显示 pending 状态的生成记录。对于正在进行的生成，请轮询 action\_request\_get。
* 元数据记录在过期或删除后仍可能存在。请在 expiresAt 之前使用 thumbnails\_download 获取 WebP 字节数据；成功读取元数据不保证可下载。

## 用量

每次成功调用消耗一次月度 API/MCP 调用额度。媒体额度和操作本身的生成限额也适用。

## 错误

| HTTP 状态 | 代码 | 含义或恢复方式 |
| - | - | - |
| 400 | `CREDENTIAL_IN_QUERY` | 凭证通过 access\_token 或 api\_key 查询参数提供。请在标头中发送凭证。 |
| 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` | 找不到实际生效的团队所有者账户。 |
| 404 | `THUMBNAIL_NOT_FOUND` | 该生成记录不存在或未由已连接用户领取。 |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | 请等待月度额度重置，或更改套餐。 |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | 如果提供了 Retry-After，请等待其指定的时间，并采用退避重试。 |
| 500 | `INTERNAL_ERROR` | 在决定是否重试修改操作前，请检查已保存的请求状态和资源历史记录。 |
| 503 | `SERVER_RESTARTING` | 服务器正在重启。请稍后重试；对于修改操作，请保持请求标识符不变。 |

```json theme={null}
{
  "code": "INSUFFICIENT_SCOPE",
  "message": "This credential does not permit the requested action.",
  "status": 403,
  "details": {
    "requiredScopes": ["thumbnails:read"]
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.