> ## 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.

# 列出已生成的语音

> 按从新到旧的顺序列出语音历史记录。将 nextCursor 作为 cursor 传入，以获取更早的生成结果。

按从新到旧的顺序列出语音历史记录。将 nextCursor 作为 cursor 传入，以获取更早的生成结果。

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

## 身份验证和权限

**x-api-key** `string` *required*

在此请求头中发送 VoiceCheap API 密钥。也支持通过 Authorization: Bearer 发送同一 API 密钥。OAuth 访问令牌仅适用于 MCP，此 REST 端点不接受 OAuth
访问令牌。

所需权限: `tts:read`.

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

## 参数

**limit** `integer`

整数值。

最小值: 1. 最大值: 100. 默认值: 30.

**cursor** `string`

由 tts\_generate 或 tts\_list 返回的历史记录 ID。

匹配模式: `^(free-)?[0-9a-f]{64}$`.

> [accordion] 完整输入架构
>
> 以下 JSON Schema 保留了发现接口公开的确切字段名、嵌套类型、默认值、范围和可接受值。其他跨字段规则列于操作说明中。
>
> ```json theme={null}
> {
>   "type": "object",
>   "properties": {
>     "limit": {
>       "default": 30,
>       "type": "integer",
>       "minimum": 1,
>       "maximum": 100
>     },
>     "cursor": {
>       "type": "string",
>       "pattern": "^(free-)?[0-9a-f]{64}$",
>       "description": "History ID returned by tts_generate or tts_list."
>     }
>   },
>   "additionalProperties": false
> }
> ```

## 请求示例

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

```bash cURL theme={null}
curl --request POST 'https://api.voicecheap.ai/v1/actions/tts_list' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"limit":1}'
```

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

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

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

## 响应

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

按最新记录优先排列的语音历史摘要分页，以及用于请求较早生成记录的游标。

```json HTTP 200 theme={null}
{
  "data": {
    "items": [
      {
        "historyId": "722c80c6412edd4c3dcd625061e1c1feafbb0d54274d95fd8b5ca047f8cdd23d",
        "textPreview": "Hello world.",
        "voice": "933563129e564b19a115bedd57b7406a",
        "voiceName": "Sarah",
        "voiceSource": "catalog",
        "inputType": "text",
        "instructionPreset": "narrator",
        "sourceFileName": "launch-script.txt",
        "characterCount": 12,
        "durationSeconds": 1.5,
        "isPreview": false,
        "createdAt": 1792152000000,
        "updatedAt": 1792152000000,
        "status": "success"
      }
    ],
    "nextCursor": "722c80c6412edd4c3dcd625061e1c1feafbb0d54274d95fd8b5ca047f8cdd23d"
  }
}
```

## 结果字段

| 字段 | 说明 |
| - | - |
| `data.items` | 语音历史记录摘要，按从新到旧排序。 |
| `data.items[].historyId` | 当前账户拥有的语音历史记录 ID：64 个小写十六进制字符，应用内预览可带 free- 前缀。 |
| `data.items[].voice` | 原始 TTS 选择 ID，已保存的自定义音色包含 clone:\<UUID>。 |
| `data.items[].voiceName` | 所选音色的已保存显示名称，可选。 |
| `data.items[].voiceSource` | 可选的音色来源：catalog 或 clone。 |
| `data.items[].inputType` | 原始输入类型：text 或 pdf。 |
| `data.items[].instructionPreset` | 已存储的表达预设。 |
| `data.items[].sourceFileName` | 生成时提供的可选原始文件名。 |
| `data.items[].characterCount` | 此次语音生成记录的字符数。 |
| `data.items[].durationSeconds` | 音频时长，以秒为单位。 |
| `data.items[].createdAt` | 创建时间，采用 Unix 毫秒时间戳。 |
| `data.items[].updatedAt` | 最后更新时间，采用 Unix 毫秒时间戳。 |
| `data.items[].status` | 已存储的成功语音条目使用 success；tts\_generate 在其生成结果中使用 completed。 |
| `data.items[].textPreview` | 已存储文稿的前 180 个字符。 |
| `data.items[].isPreview` | 音频仅包含已存储文稿的预览时为 true。 |
| `data.nextCursor` | 满页时为最后一项的 historyId，否则为 null。 |

## 操作说明

* limit 默认为 30，范围为 1 至 100。将返回的 nextCursor 作为 cursor 传入，以获取下一页。
* 返回的条目少于 limit 时，nextCursor 为 null。最后一页如果恰好已满，仍可能返回游标；下一次调用可能为空。
* 每个 textPreview 最多包含前 180 个字符。请使用 tts\_get 获取完整脚本和音频 URL。
* 历史条目报告 status: success，与语音生成结果中的 status: completed 不同。
* 语音历史记录和自定义音色归已认证账户所有。使用团队计费并不授予访问其他成员语音或音色的权限。

## 用量

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

## 错误

| HTTP 状态 | 代码 | 含义或恢复方式 |
| - | - | - |
| 400 | `CREDENTIAL_IN_QUERY` | 凭证通过 access\_token 或 api\_key 查询参数提供。请在标头中发送凭证。 |
| 400 | `VALIDATION_ERROR` | 输入不符合操作架构；请查看 details 了解字段错误。 |
| 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` | 服务器正在重启。请稍后重试；对于修改操作，请保持请求标识符不变。 |

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


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