curl --request POST 'https://api.voicecheap.ai/v1/actions/segment_actions_cancel' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"projectId":"project_launch_2026","jobId":"41321bda-e243-4b6f-96a4-622cd047c991","requestId":"c6d1fec6-bf7d-40aa-91e7-e4b0676d6020"}'
const input = {
projectId: 'project_launch_2026',
jobId: '41321bda-e243-4b6f-96a4-622cd047c991',
requestId: 'c6d1fec6-bf7d-40aa-91e7-e4b0676d6020',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/segment_actions_cancel', {
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/segment_actions_cancel",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"projectId": "project_launch_2026", "jobId": "41321bda-e243-4b6f-96a4-622cd047c991", "requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"projectId": "project_launch_2026",
"revision": 2,
"items": [
{
"id": "41321bda-e243-4b6f-96a4-622cd047c991",
"action": {
"type": "text",
"segmentIndex": 0,
"source": "original"
},
"status": "cancelled",
"createdAt": 1792152000000,
"finishedAt": 1792152002000
}
]
},
"requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020"
}
{
"data": {
"requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020",
"operation": "segment_actions_cancel",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020"
}
{
"data": {
"requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020",
"operation": "segment_actions_cancel",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020"
}
转写文本和编辑
取消排队中的片段操作
取消当前账户待处理的片段操作。已开始运行的操作无法取消。
POST
/
v1
/
actions
/
segment_actions_cancel
curl --request POST 'https://api.voicecheap.ai/v1/actions/segment_actions_cancel' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"projectId":"project_launch_2026","jobId":"41321bda-e243-4b6f-96a4-622cd047c991","requestId":"c6d1fec6-bf7d-40aa-91e7-e4b0676d6020"}'
const input = {
projectId: 'project_launch_2026',
jobId: '41321bda-e243-4b6f-96a4-622cd047c991',
requestId: 'c6d1fec6-bf7d-40aa-91e7-e4b0676d6020',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/segment_actions_cancel', {
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/segment_actions_cancel",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"projectId": "project_launch_2026", "jobId": "41321bda-e243-4b6f-96a4-622cd047c991", "requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"projectId": "project_launch_2026",
"revision": 2,
"items": [
{
"id": "41321bda-e243-4b6f-96a4-622cd047c991",
"action": {
"type": "text",
"segmentIndex": 0,
"source": "original"
},
"status": "cancelled",
"createdAt": 1792152000000,
"finishedAt": 1792152002000
}
]
},
"requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020"
}
{
"data": {
"requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020",
"operation": "segment_actions_cancel",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020"
}
{
"data": {
"requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020",
"operation": "segment_actions_cancel",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020"
}
取消当前账户待处理的片段操作。已开始运行的操作无法取消。
所需权限:
POST https://api.voicecheap.ai/v1/actions/segment_actions_cancel
身份验证和权限
string
必填
在此请求头中发送 VoiceCheap API 密钥。也支持通过 Authorization: Bearer 发送同一 API 密钥。OAuth 访问令牌仅适用于 MCP，此 REST 端点不接受 OAuth
访问令牌。
translations:write.
需要有效的付费订阅。权限不会改变团队角色、资源归属、媒体额度或套餐限制。
参数
string
必填
文本值。最小长度: 1. 最大长度: 200. 匹配模式:
^[^/\\]+$.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)$.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": {
"projectId": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^/\\\\]+$"
},
"jobId": {
"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)$"
},
"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."
}
},
"required": ["projectId", "jobId"],
"additionalProperties": false
}
幂等性
为每次修改操作在 requestId 或 Idempotency-Key HTTP 请求头中提供 UUID v4。网络故障后，请使用相同标识符和完全相同的参数重试。如果同时提供这两个值，它们必须一致。重放已保存的请求不会重复执行操作，也不会再次扣除月度调用次数。失败或中断的请求不会自动重新执行。 对于每次修改操作，如果重试时发现同一请求仍在运行，即使首次执行通常为同步操作，也可能返回 HTTP 202。如果执行已完成但 resultStored 为 false，重试会返回 HTTP 200 和已保存的请求状态，而非原始结果。请通过对应领域的历史记录、结果或下载操作获取输出。请求示例
请将示例资源标识符和媒体键替换为账户返回的值。重试同一次修改操作时，请保持请求标识符不变。curl --request POST 'https://api.voicecheap.ai/v1/actions/segment_actions_cancel' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"projectId":"project_launch_2026","jobId":"41321bda-e243-4b6f-96a4-622cd047c991","requestId":"c6d1fec6-bf7d-40aa-91e7-e4b0676d6020"}'
const input = {
projectId: 'project_launch_2026',
jobId: '41321bda-e243-4b6f-96a4-622cd047c991',
requestId: 'c6d1fec6-bf7d-40aa-91e7-e4b0676d6020',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/segment_actions_cancel', {
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/segment_actions_cancel",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"projectId": "project_launch_2026", "jobId": "41321bda-e243-4b6f-96a4-622cd047c991", "requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
响应
首次执行成功时返回 HTTP 200，操作结果位于 data 下。重放请求时可能改为返回已保存的请求状态。示例展示了一种支持的响应，并未包含所有可选字段。 取消仍在排队的操作后，返回完整的最新队列快照。{
"data": {
"projectId": "project_launch_2026",
"revision": 2,
"items": [
{
"id": "41321bda-e243-4b6f-96a4-622cd047c991",
"action": {
"type": "text",
"segmentIndex": 0,
"source": "original"
},
"status": "cancelled",
"createdAt": 1792152000000,
"finishedAt": 1792152002000
}
]
},
"requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020"
}
{
"data": {
"requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020",
"operation": "segment_actions_cancel",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020"
}
{
"data": {
"requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020",
"operation": "segment_actions_cancel",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020"
}
结果字段
| 字段 | 说明 |
|---|---|
data.projectId | 父项目标识符。 |
data.revision | 队列快照修订号。它独立于 projects_get.segmentStructureRevision。 |
data.items | 项目操作进度：任务标识符、操作元数据、状态、时间戳以及可选的公开 errorCode。 |
data.items[].id | 任务标识符；等于原始队列提交的 requestId。 |
data.items[].action | 仅包含操作元数据：type、segmentIndex，以及可选的 workId、translatedVersionId 和 source。不会返回提交的文本、时间值和重新生成指令。 |
data.items[].status | queued、running、completed、failed 或 cancelled。 |
data.items[].createdAt | 队列项创建时间，以 Unix 毫秒表示。 |
data.items[].startedAt | 可选的首次开始时间，采用 Unix 毫秒时间戳。 |
data.items[].finishedAt | 可选的结束时间，采用 Unix 毫秒时间戳。 |
data.items[].errorCode | 可选的公开错误代码。未分类的失败使用 ACTION_FAILED。 |
data.items[].seenAt | 仅针对已通过身份验证的查看者的可选确认时间。 |
恢复并轮询此请求
即使连接丢失，也应使用同一标识符。如果 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":"c6d1fec6-bf7d-40aa-91e7-e4b0676d6020","operation":"segment_actions_cancel"}'
HTTP 200
{
"data": {
"requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020",
"operation": "segment_actions_cancel",
"status": "completed",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"resultStored": true,
"result": {
"projectId": "project_launch_2026",
"revision": 2,
"items": [
{
"id": "41321bda-e243-4b6f-96a4-622cd047c991",
"action": {
"type": "text",
"segmentIndex": 0,
"source": "original"
},
"status": "cancelled",
"createdAt": 1792152000000,
"finishedAt": 1792152002000
}
]
}
}
}
操作说明
- jobId 标识要取消的队列条目；requestId 是取消请求使用的另一个稳定 UUID v4。
- 只有排队中的项目才能变为 cancelled。运行中、已完成和已失败的项目无法取消。取消已为 cancelled 的项目会返回当前快照。
- 处理程序直接返回 projectId、revision 和 items；没有 success 布尔值或嵌套的 queue 字段。
- 取消操作不会退还已完成生成的费用，也不会停止已在运行的媒体任务。
- 包括提交、取消、轮询和重放在内的队列响应仅包含操作元数据。请使用 transcripts_get 并具备所需的 transcription:read 权限来读取转录内容。
用量
每次成功调用消耗一次月度 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 | 请根据架构更正输入。无效或不一致的值会在执行前被拒绝。 |
| 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 | 请授予全部所需权限，或选择其他凭据。 |
| 403 | INTEGRATION_PLAN_UNSUPPORTED | 无法验证该账户的集成限制。 |
| 403 | SUBSCRIPTION_REQUIRED | 请使用有效的付费订阅。 |
| 403 | TEAM_OWNER_NOT_FOUND | 找不到实际生效的团队所有者账户。 |
| 404 | NOT_FOUND | 项目中不存在此 jobId 对应的队列条目。 |
| 404 | PROJECT_NOT_FOUND | 可访问的账户中不存在此项目。 |
| 409 | CONCURRENT_ACTION_LIMIT_REACHED | 此账户已有 10 个集成操作正在运行。请先轮询现有请求，再启动另一个操作。 |
| 409 | CONFLICT | 只有等待中的操作可取消；该项已开始或已结束。 |
| 409 | IDEMPOTENCY_CONFLICT | 只有操作和参数完全相同时，才能复用标识符。 |
| 429 | INTEGRATION_MONTHLY_LIMIT_REACHED | 请等待月度额度重置，或更改套餐。 |
| 429 | INTEGRATION_RATE_LIMIT_REACHED | 如果提供了 Retry-After，请等待其指定的时间，并采用退避重试。 |
| 500 | 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": ["translations:write"]
}
}
此页面对您有帮助吗？