curl --request POST 'https://api.voicecheap.ai/v1/actions/transcription_result_download' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"resultId":"b3caf96f-5f2a-4619-832c-a12c0d57f78b"}'
const input = {
resultId: 'b3caf96f-5f2a-4619-832c-a12c0d57f78b',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/transcription_result_download', {
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/transcription_result_download",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"resultId": "b3caf96f-5f2a-4619-832c-a12c0d57f78b"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"resultId": "b3caf96f-5f2a-4619-832c-a12c0d57f78b",
"operation": "transcription_create",
"createdAt": 1792152000000,
"fileName": "voicecheap-transcription_create-b3caf96f-5f2a-4619-832c-a12c0d57f78b.json",
"byteLength": 116,
"contentType": "application/json; charset=utf-8",
"status": "completed",
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"getAction": "transcription_result_get",
"downloadAction": "transcription_result_download",
"listAction": "transcription_result_list",
"content": "{\"transcript\":{\"raw\":\"Hello world.\",\"paragraphs\":\"Hello world.\",\"sentences\":\"Hello world.\",\"detectedLanguage\":\"en\"}}"
}
}
转写
导出已保存的转写操作结果
将当前账户拥有的完整结果导出为带文件名和内容类型的 JSON 文本。访问仍需要身份验证；转写文本不会通过公开的媒体 URL 暴露。
POST
/
v1
/
actions
/
transcription_result_download
curl --request POST 'https://api.voicecheap.ai/v1/actions/transcription_result_download' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"resultId":"b3caf96f-5f2a-4619-832c-a12c0d57f78b"}'
const input = {
resultId: 'b3caf96f-5f2a-4619-832c-a12c0d57f78b',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/transcription_result_download', {
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/transcription_result_download",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"resultId": "b3caf96f-5f2a-4619-832c-a12c0d57f78b"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"resultId": "b3caf96f-5f2a-4619-832c-a12c0d57f78b",
"operation": "transcription_create",
"createdAt": 1792152000000,
"fileName": "voicecheap-transcription_create-b3caf96f-5f2a-4619-832c-a12c0d57f78b.json",
"byteLength": 116,
"contentType": "application/json; charset=utf-8",
"status": "completed",
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"getAction": "transcription_result_get",
"downloadAction": "transcription_result_download",
"listAction": "transcription_result_list",
"content": "{\"transcript\":{\"raw\":\"Hello world.\",\"paragraphs\":\"Hello world.\",\"sentences\":\"Hello world.\",\"detectedLanguage\":\"en\"}}"
}
}
将当前账户拥有的完整结果导出为带文件名和内容类型的 JSON 文本。访问仍需要身份验证；转写文本不会通过公开的媒体 URL 暴露。
所需权限:
POST https://api.voicecheap.ai/v1/actions/transcription_result_download
身份验证和权限
string
必填
在此请求头中发送 VoiceCheap API 密钥。也支持通过 Authorization: Bearer 发送同一 API 密钥。OAuth 访问令牌仅适用于 MCP，此 REST 端点不接受 OAuth
访问令牌。
transcription:read.
需要有效的付费订阅。权限不会改变团队角色、资源归属、媒体额度或套餐限制。
参数
string
必填
文本值。格式: “uuid”. 匹配模式:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$.完整输入架构
完整输入架构
以下 JSON Schema 保留了发现接口公开的确切字段名、嵌套类型、默认值、范围和可接受值。其他跨字段规则列于操作说明中。
{
"type": "object",
"properties": {
"resultId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"required": ["resultId"],
"additionalProperties": false
}
请求示例
请将示例资源标识符和媒体键替换为账户返回的值。重试同一次修改操作时，请保持请求标识符不变。curl --request POST 'https://api.voicecheap.ai/v1/actions/transcription_result_download' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"resultId":"b3caf96f-5f2a-4619-832c-a12c0d57f78b"}'
const input = {
resultId: 'b3caf96f-5f2a-4619-832c-a12c0d57f78b',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/transcription_result_download', {
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/transcription_result_download",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"resultId": "b3caf96f-5f2a-4619-832c-a12c0d57f78b"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
响应
首次执行成功时返回 HTTP 200，操作结果位于 data 下。重放请求时可能改为返回已保存的请求状态。示例展示了一种支持的响应，并未包含所有可选字段。 已保存的输出元数据，其中完整生成的 JSON 被序列化为 content 字符串，供认证后的本地导出使用。{
"data": {
"resultId": "b3caf96f-5f2a-4619-832c-a12c0d57f78b",
"operation": "transcription_create",
"createdAt": 1792152000000,
"fileName": "voicecheap-transcription_create-b3caf96f-5f2a-4619-832c-a12c0d57f78b.json",
"byteLength": 116,
"contentType": "application/json; charset=utf-8",
"status": "completed",
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"getAction": "transcription_result_get",
"downloadAction": "transcription_result_download",
"listAction": "transcription_result_list",
"content": "{\"transcript\":{\"raw\":\"Hello world.\",\"paragraphs\":\"Hello world.\",\"sentences\":\"Hello world.\",\"detectedLanguage\":\"en\"}}"
}
}
结果字段
| 字段 | 说明 |
|---|---|
data.resultId | 当前账户拥有的已保存输出的 UUID。将其用于 getAction 或 downloadAction；它不同于 requestId 和任何 historyId。 |
data.operation | 生成此已保存 JSON 的生成操作。 |
data.createdAt | 已保存的输出准备完成时的 Unix 毫秒时间戳。 |
data.fileName | JSON 导出的建议文件名。 |
data.byteLength | 完整序列化输出的 UTF-8 字节，不是精简元数据。 |
data.contentType | application/json; charset=utf-8。 |
data.status | 生成成功时为 completed。结果历史记录也可能显示待恢复条目。 |
data.requestId | 已记录时，为原始操作请求 UUID。 |
data.getAction | 检索当前账户拥有的内容的操作；includeContent 默认为 false，获取完整结构化输出时必须为 true。 |
data.downloadAction | 需要认证的导出操作，以内容字符串形式返回完整 JSON。 |
data.listAction | 此权限领域中用于列出当前账户拥有的已保存输出的操作。 |
data.content | 编码为 JSON 文本的完整原始公开生成结果，可直接保存到 fileName。 |
操作说明
- 需要付费订阅和操作权限。执行时会重新检查调用者的个人工具套餐；已保存的工具和上传引用均属于该调用者，包括凭据与团队关联时。
- 成功操作会消耗一次 API/MCP 共用的每月调用次数。Beginner 每月 500 次、Starter 5,000 次、Creator 25,000 次；Pro、Scale 和 Enterprise 无每月上限。每分钟限制仍然适用，分别为 30、60、120、180、300 和 600 次。工具生成限额单独计算。
- resultId 是来自已完成生成的引用或此域 result_list 的 UUID。它不同于操作的 requestId 和网页工具的 historyId。
- 结果归属于经过身份验证的调用者和权限域。无法通过 transcription 操作读取 subtitles 结果，反之亦然。
- 完整的已保存 JSON 采用静态加密存储，独立于保留范围有限的操作轮询缓存。获取时仍需认证；不会提供公开的转写文本或字幕 JSON URL。
- 这些操作获取现有输出，不会生成媒体或使用每日限额。每次成功获取仍会消耗一次每月集成调用。
- pending 元数据表示输出持久化需要恢复。读取内容或下载时会尝试恢复已保存的加密对象；开始另一次生成前，请先检查该对象。
- 使用 UTF-8 将 content 写入 fileName，或通过 JSON.parse(content) 还原结构化输出。外层响应不包含 result 属性或媒体下载 URL。
- byteLength 描述 content 中 UTF-8 JSON 的字节长度；contentType 为 application/json; charset=utf-8。下载也会尝试恢复待处理的加密输出。
用量
每次成功调用消耗一次月度 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 | API 密钥或 MCP 连接缺少所需的操作权限。 |
| 403 | INTEGRATION_PLAN_UNSUPPORTED | 无法验证该账户的集成限制。 |
| 403 | PAID_SUBSCRIPTION_REQUIRED | 此工具操作执行时，已认证的调用者已无付费订阅。 |
| 403 | SUBSCRIPTION_REQUIRED | 请使用有效的付费订阅。 |
| 403 | TEAM_OWNER_NOT_FOUND | 找不到实际生效的团队所有者账户。 |
| 404 | TOOL_RESULT_NOT_FOUND | 结果不存在、属于其他调用者或属于另一权限域。 |
| 410 | TOOL_RESULT_ACCOUNT_UNAVAILABLE | 恢复过程中，调用者账户正在删除或已不存在。 |
| 429 | INTEGRATION_MONTHLY_LIMIT_REACHED | 已使用和待处理的调用次数已达到共享的每月 API/MCP 限额。 |
| 429 | INTEGRATION_RATE_LIMIT_REACHED | 该账户已达到每分钟集成调用上限；请检查 retryAfterSeconds。 |
| 500 | INTERNAL_ERROR | 无法读取或验证已保存的完整 JSON。 |
| 503 | INTERNAL_ERROR | 状态为 pending 的已保存结果尚无法恢复；重新生成前请检查同一个结果。 |
| 503 | SERVER_RESTARTING | 服务器正在重启。请稍后重试；对于修改操作，请保持请求标识符不变。 |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["transcription:read"]
}
}
此页面对您有帮助吗？