从 URL 导入媒体（转写）

curl --request POST 'https://api.voicecheap.ai/v1/actions/tools_upload_import' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"url":"https://media.example.com/interview.mp4","filename":"interview.mp4","kind":"transcription","requestId":"13579bdf-2468-4ace-8bdf-0123456789ab"}'

const input = {
  url: 'https://media.example.com/interview.mp4',
  filename: 'interview.mp4',
  kind: 'transcription',
  requestId: '13579bdf-2468-4ace-8bdf-0123456789ab',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/tools_upload_import', {
  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/tools_upload_import",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"url": "https://media.example.com/interview.mp4", "filename": "interview.mp4", "kind": "transcription", "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"},
    timeout=120,
)
body = response.json()
if not response.ok:
    raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)

{
  "data": {
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
    "status": "running",
    "pollAction": "action_request_get",
    "pollAfterSeconds": 5
  },
  "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}

{
  "data": {
    "fileKey": "uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.mp4",
    "fileName": "interview.mp4",
    "fileSize": 1048576,
    "durationSeconds": 60,
    "mimeType": "video/mp4",
    "uploadType": "video",
    "readUrl": "https://media.example.com/uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.mp4"
  },
  "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}

{
  "data": {
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
    "operation": "tools_upload_import",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "status": "running",
    "pollAfterSeconds": 5
  },
  "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}

{
  "data": {
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
    "operation": "tools_upload_import",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "status": "completed",
    "resultStored": false,
    "message": "The action completed. Retrieve its output from the corresponding history or resource action."
  },
  "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}

POST

actions

tools_upload_import

curl --request POST 'https://api.voicecheap.ai/v1/actions/tools_upload_import' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"url":"https://media.example.com/interview.mp4","filename":"interview.mp4","kind":"transcription","requestId":"13579bdf-2468-4ace-8bdf-0123456789ab"}'

const input = {
  url: 'https://media.example.com/interview.mp4',
  filename: 'interview.mp4',
  kind: 'transcription',
  requestId: '13579bdf-2468-4ace-8bdf-0123456789ab',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/tools_upload_import', {
  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/tools_upload_import",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"url": "https://media.example.com/interview.mp4", "filename": "interview.mp4", "kind": "transcription", "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"},
    timeout=120,
)
body = response.json()
if not response.ok:
    raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)

{
  "data": {
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
    "status": "running",
    "pollAction": "action_request_get",
    "pollAfterSeconds": 5
  },
  "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}

{
  "data": {
    "fileKey": "uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.mp4",
    "fileName": "interview.mp4",
    "fileSize": 1048576,
    "durationSeconds": 60,
    "mimeType": "video/mp4",
    "uploadType": "video",
    "readUrl": "https://media.example.com/uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.mp4"
  },
  "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}

{
  "data": {
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
    "operation": "tools_upload_import",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "status": "running",
    "pollAfterSeconds": 5
  },
  "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}

{
  "data": {
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
    "operation": "tools_upload_import",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "status": "completed",
    "resultStored": false,
    "message": "The action completed. Retrieve its output from the corresponding history or resource action."
  },
  "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}

将公开可直接访问的 HTTPS 音频或视频 URL 导入账户。不接受重定向或私有网络地址；文件和时长限制仍适用。请在生成操作中使用返回的 fileKey。

POST https://api.voicecheap.ai/v1/actions/tools_upload_import

身份验证和权限

string

必填

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

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

参数

string

必填

文本值。最大长度: 4096. 格式: “uri”.

string

文本值。最小长度: 1. 最大长度: 255. 匹配模式: ^[^/\\\r\n\0]+$.

string

必填

文本值。允许的值: “transcription”, “video_to_srt”, “add_subtitles”, “animated_captions”, “project”.

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}$.

完整输入架构

以下 JSON Schema 保留了发现接口公开的确切字段名、嵌套类型、默认值、范围和可接受值。其他跨字段规则列于操作说明中。

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "maxLength": 4096,
      "format": "uri"
    },
    "filename": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "pattern": "^[^/\\\\\\r\\n\\0]+$"
    },
    "kind": {
      "type": "string",
      "enum": ["transcription", "video_to_srt", "add_subtitles", "animated_captions", "project"]
    },
    "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}$"
    }
  },
  "required": ["url", "kind"],
  "additionalProperties": false
}

幂等性

为每次修改操作在 requestId 或 Idempotency-Key HTTP 请求头中提供 UUID v4。网络故障后，请使用相同标识符和完全相同的参数重试。如果同时提供这两个值，它们必须一致。重放已保存的请求不会重复执行操作，也不会再次扣除月度调用次数。失败或中断的请求不会自动重新执行。对于每次修改操作，如果重试时发现同一请求仍在运行，即使首次执行通常为同步操作，也可能返回 HTTP 202。如果执行已完成但 resultStored 为 false，重试会返回 HTTP 200 和已保存的请求状态，而非原始结果。请通过对应领域的历史记录、结果或下载操作获取输出。

请求示例

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

curl --request POST 'https://api.voicecheap.ai/v1/actions/tools_upload_import' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"url":"https://media.example.com/interview.mp4","filename":"interview.mp4","kind":"transcription","requestId":"13579bdf-2468-4ace-8bdf-0123456789ab"}'

const input = {
  url: 'https://media.example.com/interview.mp4',
  filename: 'interview.mp4',
  kind: 'transcription',
  requestId: '13579bdf-2468-4ace-8bdf-0123456789ab',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/tools_upload_import', {
  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/tools_upload_import",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"url": "https://media.example.com/interview.mp4", "filename": "interview.mp4", "kind": "transcription", "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"},
    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。已完成的结果可能指向独立的媒体任务；请继续使用该操作对应的状态或输出操作。已导入且属于调用者的媒体引用，包含已验证的大小、时长、媒体类型和读取 URL。这是轮询后获得的已完成操作输出。

{
  "data": {
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
    "status": "running",
    "pollAction": "action_request_get",
    "pollAfterSeconds": 5
  },
  "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}

{
  "data": {
    "fileKey": "uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.mp4",
    "fileName": "interview.mp4",
    "fileSize": 1048576,
    "durationSeconds": 60,
    "mimeType": "video/mp4",
    "uploadType": "video",
    "readUrl": "https://media.example.com/uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.mp4"
  },
  "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}

{
  "data": {
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
    "operation": "tools_upload_import",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "status": "running",
    "pollAfterSeconds": 5
  },
  "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}

{
  "data": {
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
    "operation": "tools_upload_import",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "status": "completed",
    "resultStored": false,
    "message": "The action completed. Retrieve its output from the corresponding history or resource action."
  },
  "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}

结果字段

字段	说明
`data.fileKey`	当前账户拥有的、供生成操作使用的已完成引用。
`data.fileName`	经过清理的导入文件名。
`data.fileSize`	已下载的源文件字节。
`data.durationSeconds`	探测到的源文件时长，单位为秒。
`data.mimeType`	根据受支持的文件扩展名推断的媒体 MIME 类型。
`data.uploadType`	audio 或 video。
`data.readUrl`	用于读取已导入源文件的临时 URL；生成时使用 fileKey。

恢复并轮询此请求

即使连接丢失，也应使用同一标识符。如果 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":"13579bdf-2468-4ace-8bdf-0123456789ab","operation":"tools_upload_import"}'

HTTP 200

{
  "data": {
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
    "operation": "tools_upload_import",
    "status": "completed",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "resultStored": true,
    "result": {
      "fileKey": "uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.mp4",
      "fileName": "interview.mp4",
      "fileSize": 1048576,
      "durationSeconds": 60,
      "mimeType": "video/mp4",
      "uploadType": "video",
      "readUrl": "https://media.example.com/uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.mp4"
    }
  }
}

操作说明

需要付费订阅和操作权限。执行时会重新检查调用者的个人工具套餐；已保存的工具和上传引用均属于该调用者，包括凭据与团队关联时。
成功操作会消耗一次 API/MCP 共用的每月调用次数。Beginner 每月 500 次、Starter 5,000 次、Creator 25,000 次；Pro、Scale 和 Enterprise 无每月上限。每分钟限制仍然适用，分别为 30、60、120、180、300 和 600 次。工具生成限额单独计算。
使用 UUID v4 格式的 requestId，或值与其相同的 Idempotency-Key 请求头，并在重试时保持操作、ID 和参数不变。返回缓存结果不会再次消耗每月调用次数。
上传前缀决定所需权限。tools 使用 transcription:write，subtitles 使用 subtitles:write，projects 使用 projects:write，voices 使用 voices:write。
对于工具、字幕和项目，kind 接受 transcription、video_to_srt、add_subtitles、animated_captions 或 project。所选 kind 决定工作流限制；前缀不会强制指定 kind。
所选 kind 适用各自的限制：transcription 为 200 MiB；video_to_srt 和 add_subtitles 为 300 MiB；animated_captions 为 250 MiB 且仅限音频；project 使用套餐上传上限（Beginner 5 GiB、Starter 10 GiB、Creator 20 GiB、Pro 30 GiB、Scale 40 GiB、Enterprise 60 GiB）。独立媒体最长为 2 小时。字幕在 Beginner 套餐下最长为 30 分钟，在更高的公开套餐下为 60 分钟，另允许 2 秒的容器时长容差。项目时长最长为 2 小时，Enterprise 套餐为 3 小时。
此操作异步运行。使用其操作名称和原始 requestId 轮询 action_request_get，直至完成后再从结果中获取 fileKey。
使用公开 HTTPS 音频/视频文件的直接 URL。不接受重定向、凭据、片段标识符、非 443 端口和非公开 DNS 地址。YouTube 观看页面不是直接媒体 URL；请使用专用的 YouTube 操作。
当 URL 路径以受支持的媒体文件名结尾时，filename 可选。已保存的文件名会经过清理。服务器会在返回 fileKey 前探测实际时长。
导入会准备媒体，并计入一次成功的每月集成调用；每日工具生成限额仅在后续生成时消耗。

用量

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

错误

HTTP 状态	代码	含义或恢复方式
400	`CREDENTIAL_IN_QUERY`	凭证通过 access_token 或 api_key 查询参数提供。请在标头中发送凭证。
400	`EMPTY_MEDIA`	直接媒体 URL 返回了空响应体。
400	`FILE_TOO_LARGE`	声明的或下载得到的源文件超过所选 kind 的上传上限。
400	`IDEMPOTENCY_CONFLICT`	标头与请求体中的请求 ID 不同。
400	`INVALID_FILE_TYPE`	所提供或从 URL 推导出的文件名缺少所选 kind 支持的扩展名。
400	`INVALID_MEDIA_DURATION`	无法探测下载媒体的时长，或其时长超过所选类型的套餐限额。
400	`INVALID_MEDIA_TYPE`	响应内容类型不是 audio、video、application/ogg 或 application/octet-stream。
400	`INVALID_MEDIA_URL`	使用不含用户凭据、片段标识符或非 443 端口的直接 HTTPS URL；请提供有效的媒体文件名。
400	`INVALID_REQUEST_ID`	requestId 或 Idempotency-Key 不是 UUID v4。
400	`MEDIA_DOWNLOAD_REFUSED`	直接下载未返回 HTTP 200。不接受重定向。
400	`MEDIA_IMPORT_FAILED`	无法下载、探测或保存源文件；请检查其公共 URL 和媒体格式。
400	`MEDIA_URL_NOT_PUBLIC`	无法解析主机名，或至少一个解析出的地址为私有地址或其他非公共地址。
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	`ACCOUNT_UNAVAILABLE`	调用者账户或计费账户不可用，或正在删除。
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`	找不到实际生效的团队所有者账户。
409	`CONCURRENT_ACTION_LIMIT_REACHED`	此账户已有 10 个集成操作正在运行。请先轮询现有请求，再启动另一个操作。
409	`IDEMPOTENCY_CONFLICT`	只有操作和参数完全相同时，才能复用标识符。
429	`INTEGRATION_MONTHLY_LIMIT_REACHED`	已使用和待处理的调用次数已达到共享的每月 API/MCP 限额。
429	`INTEGRATION_RATE_LIMIT_REACHED`	该账户已达到每分钟集成调用上限；请检查 retryAfterSeconds。
500	`INTERNAL_ERROR`	在决定是否重试修改操作前，请检查已保存的请求状态和资源历史记录。
503	`ACTION_RESULT_UNAVAILABLE`	操作已执行，但无法确认请求结果是否已持久化。开始另一次写入前，请使用相同操作和 requestId 轮询，并检查资源历史记录。
503	`SERVER_RESTARTING`	服务器正在重启。请稍后重试；对于修改操作，请保持请求标识符不变。

{
  "code": "INSUFFICIENT_SCOPE",
  "message": "This credential does not permit the requested action.",
  "status": 403,
  "details": {
    "requiredScopes": ["transcription:write"]
  }
}

概述

发现接口

账户

用量和活动

设置和通知

团队

项目

翻译和配音

转写文本和编辑

文本转语音

语音音色

配音音色

转写

字幕

图像

缩略图

文件夹

术语表

Webhook

发布

请求状态

OAuth 和 MCP 协议

身份验证和权限

参数

幂等性

请求示例

响应

结果字段

恢复并轮询此请求

操作说明

用量

错误

​身份验证和权限

​参数

​幂等性

​请求示例

​响应

​结果字段

​恢复并轮询此请求

​操作说明

​用量

​错误

身份验证和权限

参数

幂等性

请求示例

响应

结果字段

恢复并轮询此请求

操作说明

用量

错误