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

# 编辑转写片段

> 将原文或译文编辑加入队列。重试时 requestId 必须为稳定的 UUID。请轮询 segment_actions_list，直至完成。

将原文或译文编辑加入队列。重试时 requestId 必须为稳定的 UUID。请轮询 segment\_actions\_list，直至完成。

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

## 身份验证和权限

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

所需权限: `transcription:write`.

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

## 参数

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

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

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

  最小值: 0. 最大值: 9007199254740991.
</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>

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

  允许的值: "original", "translated".
</ParamField>

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

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

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

  最大长度: 3000.
</ParamField>

<ParamField body="enableEditing" type="boolean">
  布尔值。
</ParamField>

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

  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "projectId": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200,
        "pattern": "^[^/\\\\]+$"
      },
      "segmentIndex": {
        "type": "integer",
        "minimum": 0,
        "maximum": 9007199254740991
      },
      "requestId": {
        "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}$",
        "description": "UUID v4 for this action. Reuse the same ID with identical arguments on retries."
      },
      "source": {
        "type": "string",
        "enum": ["original", "translated"]
      },
      "workId": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200,
        "pattern": "^[^/\\\\]+$"
      },
      "text": {
        "type": "string",
        "maxLength": 3000
      },
      "enableEditing": {
        "type": "boolean"
      }
    },
    "required": ["projectId", "segmentIndex", "source", "text"],
    "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/segments_text_update' \
    --header "x-api-key: $VOICECHEAP_API_KEY" \
    --header 'Content-Type: application/json' \
    --data '{"projectId":"project_launch_2026","segmentIndex":0,"requestId":"41321bda-e243-4b6f-96a4-622cd047c991","source":"original","text":"Bienvenue au lancement de VoiceCheap."}'
  ```

  ```javascript JavaScript theme={null}
  const input = {
    projectId: 'project_launch_2026',
    segmentIndex: 0,
    requestId: '41321bda-e243-4b6f-96a4-622cd047c991',
    source: 'original',
    text: 'Bienvenue au lancement de VoiceCheap.',
  };
  const response = await fetch('https://api.voicecheap.ai/v1/actions/segments_text_update', {
    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/segments_text_update",
      headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
      json={"projectId": "project_launch_2026", "segmentIndex": 0, "requestId": "41321bda-e243-4b6f-96a4-622cd047c991", "source": "original", "text": "Bienvenue au lancement de VoiceCheap."},
      timeout=120,
  )
  body = response.json()
  if not response.ok:
      raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
  print(body)
  ```
</RequestExample>

## 响应

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

返回原文或译文编辑的入队结果以及最新队列快照。

<ResponseExample>
  ```json HTTP 200 theme={null}
  {
    "data": {
      "status": "queued",
      "jobId": "41321bda-e243-4b6f-96a4-622cd047c991",
      "queue": {
        "projectId": "project_launch_2026",
        "revision": 1,
        "items": [
          {
            "id": "41321bda-e243-4b6f-96a4-622cd047c991",
            "action": {
              "type": "text",
              "segmentIndex": 0,
              "source": "original"
            },
            "status": "queued",
            "createdAt": 1792152000000
          }
        ]
      }
    },
    "requestId": "41321bda-e243-4b6f-96a4-622cd047c991"
  }
  ```

  ```json HTTP 202 replay_running theme={null}
  {
    "data": {
      "requestId": "41321bda-e243-4b6f-96a4-622cd047c991",
      "operation": "segments_text_update",
      "createdAt": 1792144800000,
      "updatedAt": 1792144820000,
      "status": "running",
      "pollAfterSeconds": 5
    },
    "requestId": "41321bda-e243-4b6f-96a4-622cd047c991"
  }
  ```

  ```json HTTP 200 replay_completed_without_result theme={null}
  {
    "data": {
      "requestId": "41321bda-e243-4b6f-96a4-622cd047c991",
      "operation": "segments_text_update",
      "createdAt": 1792144800000,
      "updatedAt": 1792144820000,
      "status": "completed",
      "resultStored": false,
      "message": "The action completed. Retrieve its output from the corresponding history or resource action."
    },
    "requestId": "41321bda-e243-4b6f-96a4-622cd047c991"
  }
  ```
</ResponseExample>

## 结果字段

| 字段 | 说明 |
| - | - |
| `data.status` | 此任务已被领取或已开始时为 started，否则为 queued。两者均不表示已完成。 |
| `data.jobId` | 队列任务标识符，等于稳定的提交 requestId。 |
| `data.queue` | 最新的项目队列快照，可能已显示该任务正在运行或已结束。 |
| `data.queue.projectId` | 父项目标识符。 |
| `data.queue.revision` | 队列快照修订号。它独立于 projects\_get.segmentStructureRevision。 |
| `data.queue.items` | 项目操作进度：任务标识符、操作元数据、状态、时间戳以及可选的公开 errorCode。 |
| `data.queue.items[].id` | 任务标识符；等于原始队列提交的 requestId。 |
| `data.queue.items[].action` | 仅包含操作元数据：type、segmentIndex，以及可选的 workId、translatedVersionId 和 source。不会返回提交的文本、时间值和重新生成指令。 |
| `data.queue.items[].status` | queued、running、completed、failed 或 cancelled。 |
| `data.queue.items[].createdAt` | 队列项创建时间，以 Unix 毫秒表示。 |
| `data.queue.items[].startedAt` | 可选的首次开始时间，采用 Unix 毫秒时间戳。 |
| `data.queue.items[].finishedAt` | 可选的结束时间，采用 Unix 毫秒时间戳。 |
| `data.queue.items[].errorCode` | 可选的公开错误代码。未分类的失败使用 ACTION\_FAILED。 |
| `data.queue.items[].seenAt` | 仅针对已通过身份验证的查看者的可选确认时间。 |

## 恢复并轮询此请求

即使连接丢失，也应使用同一标识符。如果 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":"41321bda-e243-4b6f-96a4-622cd047c991","operation":"segments_text_update"}'
```

```json HTTP 200 theme={null}
{
  "data": {
    "requestId": "41321bda-e243-4b6f-96a4-622cd047c991",
    "operation": "segments_text_update",
    "status": "completed",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "resultStored": true,
    "result": {
      "status": "queued",
      "jobId": "41321bda-e243-4b6f-96a4-622cd047c991",
      "queue": {
        "projectId": "project_launch_2026",
        "revision": 1,
        "items": [
          {
            "id": "41321bda-e243-4b6f-96a4-622cd047c991",
            "action": {
              "type": "text",
              "segmentIndex": 0,
              "source": "original"
            },
            "status": "queued",
            "createdAt": 1792152000000
          }
        ]
      }
    }
  }
}
```

## 操作说明

* 为此次预期编辑使用一个 UUID v4 格式的 requestId，重试时使用相同参数复用该 ID。jobId 等于此 requestId。
* 入队结果为 started 或 queued，不表示完成。请轮询 segment\_actions\_list，查找 items\[].id 等于 jobId 的条目，直到状态为 completed、failed 或 cancelled，然后刷新 transcripts\_get 和 projects\_get。
* queue.revision 跟踪队列状态；它不是源片段结构修订号。队列操作在获准入队时记录当前结构。后续不兼容的结构变更可能导致条目失败，并显示 SEGMENT\_STRUCTURE\_CHANGED。
* 同一个逻辑片段目标只允许受理一个待处理操作。新 requestId 无法绕过 SEGMENT\_ACTION\_ALREADY\_PENDING。
* 队列执行失败时，条目显示 items\[].status 为 failed 并附带 errorCode，不会更改成功的提交结果。
* 编辑原文时省略 workId 和 enableEditing。原文编辑会将所有语言内容中的对应片段标记为待翻译；不会自动生成新语音。
* 编辑翻译文本时，请将 source 设为 translated 并提供 workId。同时需要 transcription:write 和 translations:write 权限。
* enableEditing 仅允许用于翻译文本编辑，并会显式切换手动翻译模式。编辑翻译文本会更新文本和编辑状态，不会重新生成其语音。
* 操作架构允许空文本字符串。请使用专用的 segments\_delete 移除片段，以保持所有语言一致。
* 包括提交、取消、轮询和重放在内的队列响应仅包含操作元数据。请使用 transcripts\_get 并具备所需的 transcription:read 权限来读取转录内容。

## 用量

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

## 错误

| HTTP 状态 | 代码 | 含义或恢复方式 |
| - | - | - |
| 400 | `BAD_REQUEST` | 源片段索引不存在或队列参数无效。 |
| 400 | `CREDENTIAL_IN_QUERY` | 凭证通过 access\_token 或 api\_key 查询参数提供。请在标头中发送凭证。 |
| 400 | `IDEMPOTENCY_CONFLICT` | Idempotency-Key 请求头必须与请求体中的 requestId 字段一致。 |
| 400 | `INVALID_REQUEST_ID` | 请在 requestId 或 Idempotency-Key 中提供 UUID v4。 |
| 400 | `SEGMENT_QUEUE_FULL` | 项目已有 50 个待处理的片段操作。 |
| 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 | `FORBIDDEN` | 通过身份验证的调用者无权访问此项目。 |
| 403 | `INSUFFICIENT_SCOPE` | 编辑翻译文本还需要 translations:write。 |
| 403 | `INTEGRATION_PLAN_UNSUPPORTED` | 无法验证该账户的集成限制。 |
| 403 | `SUBSCRIPTION_REQUIRED` | 请使用有效的付费订阅。 |
| 403 | `TEAM_OWNER_NOT_FOUND` | 找不到实际生效的团队所有者账户。 |
| 404 | `PROJECT_NOT_FOUND` | 可访问的账户中不存在此项目。 |
| 404 | `TRANSLATION_NOT_FOUND` | 翻译编辑所针对的语言内容不属于此项目。 |
| 409 | `CONCURRENT_ACTION_LIMIT_REACHED` | 此账户已有 10 个集成操作正在运行。请先轮询现有请求，再启动另一个操作。 |
| 409 | `IDEMPOTENCY_CONFLICT` | 只有操作和参数完全相同时，才能复用标识符。 |
| 409 | `SEGMENT_ACTION_ALREADY_PENDING` | 针对同一逻辑片段目标的操作已在排队或运行中。 |
| 409 | `SEGMENT_STRUCTURE_BUSY` | 片段结构变更正在进行；请重新加载项目后再提交。 |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | 请等待月度额度重置，或更改套餐。 |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | 如果提供了 Retry-After，请等待其指定的时间，并采用退避重试。 |
| 500 | `INTERNAL_ERROR` | 在决定是否重试修改操作前，请检查已保存的请求状态和资源历史记录。 |
| 503 | `ACTION_RESULT_UNAVAILABLE` | 操作已执行，但未能保存结果。在启动新的生成前，请检查已保存的请求状态和资源历史记录。 |
| 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.