curl --request POST 'https://api.voicecheap.ai/v1/actions/tts_continue' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"284a861a-4da8-4d67-ad48-8123e76c8e91","historyId":"free-ebdb6d6f77433edf7c0169994cdce394f1c9c366e4d98cd4762a037cadea0ae4"}'
const input = {
requestId: '284a861a-4da8-4d67-ad48-8123e76c8e91',
historyId: 'free-ebdb6d6f77433edf7c0169994cdce394f1c9c366e4d98cd4762a037cadea0ae4',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/tts_continue', {
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/tts_continue",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "historyId": "free-ebdb6d6f77433edf7c0169994cdce394f1c9c366e4d98cd4762a037cadea0ae4"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"status": "running",
"pollAction": "action_request_get",
"pollAfterSeconds": 5
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"historyId": "free-ebdb6d6f77433edf7c0169994cdce394f1c9c366e4d98cd4762a037cadea0ae4",
"status": "completed",
"characterCount": 12,
"previewEndIndex": null,
"downloadUrl": "https://files.example.com/completed-preview-speech.mp3"
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"operation": "tts_continue",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"operation": "tts_continue",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
文本转语音
完成语音预览
当前账户具有访问权限时,生成自有语音预览的剩余部分。重复调用会返回已完成的音频,不会再次扣除字符额度。
POST
/
v1
/
actions
/
tts_continue
curl --request POST 'https://api.voicecheap.ai/v1/actions/tts_continue' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"284a861a-4da8-4d67-ad48-8123e76c8e91","historyId":"free-ebdb6d6f77433edf7c0169994cdce394f1c9c366e4d98cd4762a037cadea0ae4"}'
const input = {
requestId: '284a861a-4da8-4d67-ad48-8123e76c8e91',
historyId: 'free-ebdb6d6f77433edf7c0169994cdce394f1c9c366e4d98cd4762a037cadea0ae4',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/tts_continue', {
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/tts_continue",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "historyId": "free-ebdb6d6f77433edf7c0169994cdce394f1c9c366e4d98cd4762a037cadea0ae4"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"status": "running",
"pollAction": "action_request_get",
"pollAfterSeconds": 5
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"historyId": "free-ebdb6d6f77433edf7c0169994cdce394f1c9c366e4d98cd4762a037cadea0ae4",
"status": "completed",
"characterCount": 12,
"previewEndIndex": null,
"downloadUrl": "https://files.example.com/completed-preview-speech.mp3"
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"operation": "tts_continue",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"operation": "tts_continue",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
当前账户具有访问权限时,生成自有语音预览的剩余部分。重复调用会返回已完成的音频,不会再次扣除字符额度。
所需权限:
POST https://api.voicecheap.ai/v1/actions/tts_continue
身份验证和权限
string
必填
在此请求头中发送 VoiceCheap API 密钥。也支持通过 Authorization: Bearer 发送同一 API 密钥。OAuth 访问令牌仅适用于 MCP,此 REST 端点不接受 OAuth
访问令牌。
tts:write.
需要有效的付费订阅。权限不会改变团队角色、资源归属、媒体额度或套餐限制。
参数
string
在传输层可选:如果省略,服务器会在验证前注入标识符。请自行提供稳定的 UUID v4,以便在响应丢失后安全恢复。格式: “uuid”. 匹配模式:
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$.string
必填
由 tts_generate 或 tts_list 返回的历史记录 ID。匹配模式:
^(free-)?[0-9a-f]{64}$.完整输入架构
完整输入架构
以下 JSON Schema 保留了发现接口公开的确切字段名、嵌套类型、默认值、范围和可接受值。其他跨字段规则列于操作说明中。
{
"type": "object",
"properties": {
"requestId": {
"description": "UUID v4 for this action. Reuse the same ID with identical arguments on retries.",
"type": "string",
"format": "uuid",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"historyId": {
"type": "string",
"pattern": "^(free-)?[0-9a-f]{64}$",
"description": "History ID returned by tts_generate or tts_list."
}
},
"required": ["historyId"],
"additionalProperties": false
}
幂等性
为每次修改操作在 requestId 或 Idempotency-Key HTTP 请求头中提供 UUID v4。网络故障后,请使用相同标识符和完全相同的参数重试。如果同时提供这两个值,它们必须一致。重放已保存的请求不会重复执行操作,也不会再次扣除月度调用次数。失败或中断的请求不会自动重新执行。 对于每次修改操作,如果重试时发现同一请求仍在运行,即使首次执行通常为同步操作,也可能返回 HTTP 202。如果执行已完成但 resultStored 为 false,重试会返回 HTTP 200 和已保存的请求状态,而非原始结果。请通过对应领域的历史记录、结果或下载操作获取输出。请求示例
请将示例资源标识符和媒体键替换为账户返回的值。重试同一次修改操作时,请保持请求标识符不变。curl --request POST 'https://api.voicecheap.ai/v1/actions/tts_continue' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"284a861a-4da8-4d67-ad48-8123e76c8e91","historyId":"free-ebdb6d6f77433edf7c0169994cdce394f1c9c366e4d98cd4762a037cadea0ae4"}'
const input = {
requestId: '284a861a-4da8-4d67-ad48-8123e76c8e91',
historyId: 'free-ebdb6d6f77433edf7c0169994cdce394f1c9c366e4d98cd4762a037cadea0ae4',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/tts_continue', {
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/tts_continue",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "historyId": "free-ebdb6d6f77433edf7c0169994cdce394f1c9c366e4d98cd4762a037cadea0ae4"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
响应
此操作在运行期间返回 HTTP 202。请保存 requestId,并使用该标识符和原始操作名称轮询 action_request_get。轮询状态包括 running、completed、failed 和 interrupted。已完成的结果可能指向独立的媒体任务;请继续使用该操作对应的状态或输出操作。 当前账户拥有的应用内预览完整音频生成完成后的元数据。保留原始 historyId。{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"status": "running",
"pollAction": "action_request_get",
"pollAfterSeconds": 5
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"historyId": "free-ebdb6d6f77433edf7c0169994cdce394f1c9c366e4d98cd4762a037cadea0ae4",
"status": "completed",
"characterCount": 12,
"previewEndIndex": null,
"downloadUrl": "https://files.example.com/completed-preview-speech.mp3"
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"operation": "tts_continue",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"operation": "tts_continue",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
结果字段
| 字段 | 说明 |
|---|---|
data.requestId | 为生成操作提供的 UUID v4。 |
data.historyId | 当前账户拥有的语音历史记录 ID:64 个小写十六进制字符,应用内预览可带 free- 前缀。 |
data.status | 语音结果就绪时为 completed。 |
data.characterCount | 去除首尾空白后的完整输入文本字符数。 |
data.previewEndIndex | 部分预览音频的字符边界;完整音频则为 null。付费集成生成会返回完整音频。 |
data.downloadUrl | 临时 MP3 下载 URL。通过 tts_download 请求新的 URL。 |
恢复并轮询此请求
即使连接丢失,也应使用同一标识符。如果 resultStored 为 false,请通过相应的历史记录、结果或下载操作获取输出。切勿仅为查看进度而启动第二次生成。curl --request POST 'https://api.voicecheap.ai/v1/actions/action_request_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"284a861a-4da8-4d67-ad48-8123e76c8e91","operation":"tts_continue"}'
HTTP 200
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"operation": "tts_continue",
"status": "completed",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"resultStored": true,
"result": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"historyId": "free-ebdb6d6f77433edf7c0169994cdce394f1c9c366e4d98cd4762a037cadea0ae4",
"status": "completed",
"characterCount": 12,
"previewEndIndex": null,
"downloadUrl": "https://files.example.com/completed-preview-speech.mp3"
}
}
}
操作说明
- 为此写入操作使用 UUID v4 格式的 requestId,重试时使用相同参数复用该 ID。长时间运行的操作首先返回 running 请求;此示例是可通过 action_request_get 获取的已完成处理程序结果。
- 升级后,请使用应用或 tts_list 中当前账户拥有的现有预览 historyId。此操作无法创建新的免费预览。
- 剩余脚本计入当前 TTS 字符限额。重复完成同一预览会复用已完成的音频,不会再次消耗这些字符额度。
- 如果该项目已完成,将返回其当前音频。结果中的 characterCount 表示完整原始脚本的字符数;解锁后,previewEndIndex 为 null。
- 语音历史记录和自定义音色归已认证账户所有。使用团队计费并不授予访问其他成员语音或音色的权限。
用量
每次成功调用消耗一次月度 API/MCP 调用额度。媒体额度和操作本身的生成限额也适用。错误
| HTTP 状态 | 代码 | 含义或恢复方式 |
|---|---|---|
| 400 | CREDENTIAL_IN_QUERY | 凭证通过 access_token 或 api_key 查询参数提供。请在标头中发送凭证。 |
| 400 | IDEMPOTENCY_CONFLICT | Idempotency-Key 请求头必须与请求体中的 requestId 字段一致。 |
| 400 | INVALID_REQUEST_ID | 请在 requestId 或 Idempotency-Key 中提供 UUID v4。 |
| 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 | ACCOUNT_UNAVAILABLE | 调用者账户或计费账户不可用,或正在删除。 |
| 403 | AMBIGUOUS_TEAM_API_KEY | 此凭据对应的用户属于多个团队,因此计费上下文不明确。 |
| 403 | INSUFFICIENT_SCOPE | 请授予全部所需权限,或选择其他凭据。 |
| 403 | INTEGRATION_PLAN_UNSUPPORTED | 无法验证该账户的集成限制。 |
| 403 | PAID_PLAN_REQUIRED | 集成语音生成需要付费套餐,包括完成应用内预览。 |
| 403 | SUBSCRIPTION_REQUIRED | 请使用有效的付费订阅。 |
| 403 | TEAM_OWNER_NOT_FOUND | 找不到实际生效的团队所有者账户。 |
| 404 | TEXT_TO_SPEECH_HISTORY_NOT_FOUND | 语音历史条目不存在,或属于其他账户。 |
| 409 | CONCURRENT_ACTION_LIMIT_REACHED | 此账户已有 10 个集成操作正在运行。请先轮询现有请求,再启动另一个操作。 |
| 409 | IDEMPOTENCY_CONFLICT | 只有操作和参数完全相同时,才能复用标识符。 |
| 409 | TEXT_TO_SPEECH_GENERATION_IN_PROGRESS | 预览完成操作仍在运行。 |
| 409 | TEXT_TO_SPEECH_REQUEST_CONFLICT | 底层的预览完成请求与已存储的输入冲突。 |
| 429 | INTEGRATION_MONTHLY_LIMIT_REACHED | 请等待月度额度重置,或更改套餐。 |
| 429 | INTEGRATION_RATE_LIMIT_REACHED | 如果提供了 Retry-After,请等待其指定的时间,并采用退避重试。 |
| 429 | TEXT_TO_SPEECH_CHARACTER_LIMIT_REACHED | 套餐内和已购买的 TTS 字符额度不足以处理剩余脚本。 |
| 500 | INTERNAL_ERROR | 在决定是否重试修改操作前,请检查已保存的请求状态和资源历史记录。 |
| 502 | INTERNAL_ERROR | 无法完成操作或确认其结果。启动另一次生成前,请检查请求状态和资源历史记录。 |
| 503 | ACTION_RESULT_UNAVAILABLE | 操作已执行,但未能保存结果。在启动新的生成前,请检查已保存的请求状态和资源历史记录。 |
| 503 | SERVER_RESTARTING | 服务器正在重启。请稍后重试;对于修改操作,请保持请求标识符不变。 |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["tts:write"]
}
}
此页面对您有帮助吗?

