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

# 初始化媒体上传（转写）

> 启动归属于当前账户的分片上传。将每个分片上传到对应的签名 URL，完成上传后再调用生成操作。

启动归属于当前账户的分片上传。将每个分片上传到对应的签名 URL，完成上传后再调用生成操作。

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

## 身份验证和权限

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

所需权限: `transcription:write`.

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

## 参数

<ParamField body="filename" type="string" required>
  文本值。

  最小长度: 1. 最大长度: 255. 匹配模式: `^[^/\\\r\n\0]+$`.
</ParamField>

<ParamField body="contentType" type="string" required>
  文本值。

  最小长度: 1. 最大长度: 120. 匹配模式: `^(audio|video)\/[A-Za-z0-9.+-]+$|^application\/octet-stream$`.
</ParamField>

<ParamField body="fileSize" type="integer" required>
  整数值。

  最大值: 64424509440.
</ParamField>

<ParamField body="kind" type="string" required>
  文本值。

  允许的值: "transcription", "video\_to\_srt", "add\_subtitles", "animated\_captions", "project".
</ParamField>

<ParamField body="requestId" type="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}$`.
</ParamField>

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

  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "filename": {
        "type": "string",
        "minLength": 1,
        "maxLength": 255,
        "pattern": "^[^/\\\\\\r\\n\\0]+$"
      },
      "contentType": {
        "type": "string",
        "minLength": 1,
        "maxLength": 120,
        "pattern": "^(audio|video)\\/[A-Za-z0-9.+-]+$|^application\\/octet-stream$"
      },
      "fileSize": {
        "type": "integer",
        "exclusiveMinimum": 0,
        "maximum": 64424509440
      },
      "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": ["filename", "contentType", "fileSize", "kind"],
    "additionalProperties": false
  }
  ```
</Accordion>

## 幂等性

为每次修改操作在 requestId 或 Idempotency-Key HTTP 请求头中提供 UUID v4。网络故障后，请使用相同标识符和完全相同的参数重试。如果同时提供这两个值，它们必须一致。重放已保存的请求不会重复执行操作，也不会再次扣除月度调用次数。失败或中断的请求不会自动重新执行。

对于每次修改操作，如果重试时发现同一请求仍在运行，即使首次执行通常为同步操作，也可能返回 HTTP 202。如果执行已完成但 resultStored 为 false，重试会返回 HTTP 200 和已保存的请求状态，而非原始结果。请通过对应领域的历史记录、结果或下载操作获取输出。

## 请求示例

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

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST 'https://api.voicecheap.ai/v1/actions/tools_upload_initialize' \
    --header "x-api-key: $VOICECHEAP_API_KEY" \
    --header 'Content-Type: application/json' \
    --data '{"filename":"interview.mp4","contentType":"video/mp4","fileSize":1048576,"kind":"transcription","requestId":"13579bdf-2468-4ace-8bdf-0123456789ab"}'
  ```

  ```javascript JavaScript theme={null}
  const input = {
    filename: 'interview.mp4',
    contentType: 'video/mp4',
    fileSize: 1048576,
    kind: 'transcription',
    requestId: '13579bdf-2468-4ace-8bdf-0123456789ab',
  };
  const response = await fetch('https://api.voicecheap.ai/v1/actions/tools_upload_initialize', {
    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/tools_upload_initialize",
      headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
      json={"filename": "interview.mp4", "contentType": "video/mp4", "fileSize": 1048576, "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)
  ```
</RequestExample>

## 响应

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

当前账户拥有的分片上传会话。key 是存储引用；将其用作生成操作的 fileKey 前，请完成所有分片的上传。

<ResponseExample>
  ```json HTTP 200 theme={null}
  {
    "data": {
      "uploadId": "a1b2c3d4-e5f6-4789-8abc-def012345678",
      "key": "uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.mp4",
      "partSize": 5242880,
      "maxConcurrency": 4
    },
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
  }
  ```

  ```json HTTP 202 replay_running theme={null}
  {
    "data": {
      "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
      "operation": "tools_upload_initialize",
      "createdAt": 1792144800000,
      "updatedAt": 1792144820000,
      "status": "running",
      "pollAfterSeconds": 5
    },
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
  }
  ```

  ```json HTTP 200 replay_completed_without_result theme={null}
  {
    "data": {
      "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
      "operation": "tools_upload_initialize",
      "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"
  }
  ```
</ResponseExample>

## 结果字段

| 字段 | 说明 |
| - | - |
| `data.uploadId` | 活动上传会话的不透明 UUID；后续多部分上传操作中应原样使用。 |
| `data.key` | 当前账户拥有的存储键。生成前必须等待 upload\_complete 完成。 |
| `data.partSize` | 每个非末尾分片的大小，单位为字节。 |
| `data.maxConcurrency` | 建议同时上传的分片数量上限。 |

## 恢复并轮询此请求

即使连接丢失，也应使用同一标识符。如果 resultStored 为 false，请通过相应的历史记录、结果或下载操作获取输出。切勿仅为查看进度而启动第二次生成。

```bash theme={null}
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_initialize"}'
```

```json HTTP 200 theme={null}
{
  "data": {
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
    "operation": "tools_upload_initialize",
    "status": "completed",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "resultStored": true,
    "result": {
      "uploadId": "a1b2c3d4-e5f6-4789-8abc-def012345678",
      "key": "uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.mp4",
      "partSize": 5242880,
      "maxConcurrency": 4
    }
  }
}
```

## 操作说明

* 需要付费订阅和操作权限。执行时会重新检查调用者的个人工具套餐；已保存的工具和上传引用均属于该调用者，包括凭据与团队关联时。
* 成功操作会消耗一次 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 小时。
* 输入文件名必须为单个文件名，不能包含斜杠、反斜杠、CR、LF 或 NUL。contentType 必须为受支持的音频/视频 MIME 类型；非音色样本上传也可使用 application/octet-stream。
* 初始化返回 key，不返回 fileKey。请单独保留 uploadId；它是用于签名、完成和中止的 UUID。
* partSize 从 5 MiB 至 100 MiB 中选择。分片数按 ceil(fileSize / partSize) 计算，并发 PUT 数不得超过 maxConcurrency，且须保留每次返回的 ETag。
* 上传会话在 24 小时后过期。准备上传不会消耗每日生成限额。

## 用量

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

## 错误

| HTTP 状态 | 代码 | 含义或恢复方式 |
| - | - | - |
| 400 | `BAD_REQUEST` | 当 kind: project 时，声明的 fileSize 超过调用者套餐的上传上限。 |
| 400 | `CREDENTIAL_IN_QUERY` | 凭证通过 access\_token 或 api\_key 查询参数提供。请在标头中发送凭证。 |
| 400 | `FILE_TOO_LARGE` | 声明的 fileSize 超过所选独立媒体工具的上传上限。 |
| 400 | `IDEMPOTENCY_CONFLICT` | 标头与请求体中的请求 ID 不同。 |
| 400 | `INVALID_FILE_TYPE` | 所选工具类型不接受该文件名和媒体类型；animated\_captions 要求使用音频扩展名。 |
| 400 | `INVALID_REQUEST_ID` | requestId 或 Idempotency-Key 不是 UUID v4。 |
| 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 | `INTERNAL_ERROR` | 上传初始化或持久化会话存储不可用。 |
| 503 | `SERVER_RESTARTING` | 服务器正在重启。请稍后重试；对于修改操作，请保持请求标识符不变。 |

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


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