curl --request POST 'https://api.voicecheap.ai/v1/actions/images_upload_abort' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"25b1b11e-ef87-44b0-aee1-c5411141c42f","uploadId":"c547fb7f-f334-46a8-a8bb-80b5b343889a"}'
const input = {
requestId: '25b1b11e-ef87-44b0-aee1-c5411141c42f',
uploadId: 'c547fb7f-f334-46a8-a8bb-80b5b343889a',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/images_upload_abort', {
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/images_upload_abort",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "25b1b11e-ef87-44b0-aee1-c5411141c42f", "uploadId": "c547fb7f-f334-46a8-a8bb-80b5b343889a"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"success": true
},
"requestId": "25b1b11e-ef87-44b0-aee1-c5411141c42f"
}
{
"data": {
"requestId": "25b1b11e-ef87-44b0-aee1-c5411141c42f",
"operation": "images_upload_abort",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "25b1b11e-ef87-44b0-aee1-c5411141c42f"
}
{
"data": {
"requestId": "25b1b11e-ef87-44b0-aee1-c5411141c42f",
"operation": "images_upload_abort",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "25b1b11e-ef87-44b0-aee1-c5411141c42f"
}
图像
取消参考图像上传
取消已连接账户拥有且尚未完成的参考图像上传。
POST
/
v1
/
actions
/
images_upload_abort
curl --request POST 'https://api.voicecheap.ai/v1/actions/images_upload_abort' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"25b1b11e-ef87-44b0-aee1-c5411141c42f","uploadId":"c547fb7f-f334-46a8-a8bb-80b5b343889a"}'
const input = {
requestId: '25b1b11e-ef87-44b0-aee1-c5411141c42f',
uploadId: 'c547fb7f-f334-46a8-a8bb-80b5b343889a',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/images_upload_abort', {
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/images_upload_abort",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "25b1b11e-ef87-44b0-aee1-c5411141c42f", "uploadId": "c547fb7f-f334-46a8-a8bb-80b5b343889a"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"success": true
},
"requestId": "25b1b11e-ef87-44b0-aee1-c5411141c42f"
}
{
"data": {
"requestId": "25b1b11e-ef87-44b0-aee1-c5411141c42f",
"operation": "images_upload_abort",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "25b1b11e-ef87-44b0-aee1-c5411141c42f"
}
{
"data": {
"requestId": "25b1b11e-ef87-44b0-aee1-c5411141c42f",
"operation": "images_upload_abort",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "25b1b11e-ef87-44b0-aee1-c5411141c42f"
}
取消已连接账户拥有且尚未完成的参考图像上传。
所需权限:
POST https://api.voicecheap.ai/v1/actions/images_upload_abort
身份验证和权限
string
必填
在此请求头中发送 VoiceCheap API 密钥。也支持通过 Authorization: Bearer 发送同一 API 密钥。OAuth 访问令牌仅适用于 MCP，此 REST 端点不接受 OAuth
访问令牌。
images:write.
需要有效的付费订阅。权限不会改变团队角色、资源归属、媒体额度或套餐限制。
参数
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}$.string
必填
此领域的 upload_initialize 操作返回的 uploadId。格式: “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": {
"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}$"
},
"uploadId": {
"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)$",
"description": "The uploadId returned by this domain’s upload_initialize action."
}
},
"required": ["uploadId"],
"additionalProperties": false
}
幂等性
为每次修改操作在 requestId 或 Idempotency-Key HTTP 请求头中提供 UUID v4。网络故障后，请使用相同标识符和完全相同的参数重试。如果同时提供这两个值，它们必须一致。重放已保存的请求不会重复执行操作，也不会再次扣除月度调用次数。失败或中断的请求不会自动重新执行。 对于每次修改操作，如果重试时发现同一请求仍在运行，即使首次执行通常为同步操作，也可能返回 HTTP 202。如果执行已完成但 resultStored 为 false，重试会返回 HTTP 200 和已保存的请求状态，而非原始结果。请通过对应领域的历史记录、结果或下载操作获取输出。请求示例
请将示例资源标识符和媒体键替换为账户返回的值。重试同一次修改操作时，请保持请求标识符不变。curl --request POST 'https://api.voicecheap.ai/v1/actions/images_upload_abort' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"25b1b11e-ef87-44b0-aee1-c5411141c42f","uploadId":"c547fb7f-f334-46a8-a8bb-80b5b343889a"}'
const input = {
requestId: '25b1b11e-ef87-44b0-aee1-c5411141c42f',
uploadId: 'c547fb7f-f334-46a8-a8bb-80b5b343889a',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/images_upload_abort', {
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/images_upload_abort",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "25b1b11e-ef87-44b0-aee1-c5411141c42f", "uploadId": "c547fb7f-f334-46a8-a8bb-80b5b343889a"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
响应
首次执行成功时返回 HTTP 200，操作结果位于 data 下。重放请求时可能改为返回已保存的请求状态。示例展示了一种支持的响应，并未包含所有可选字段。 未完成的分片上传已中止，或该 uploadId 没有活动会话时，返回 success: true。{
"data": {
"success": true
},
"requestId": "25b1b11e-ef87-44b0-aee1-c5411141c42f"
}
{
"data": {
"requestId": "25b1b11e-ef87-44b0-aee1-c5411141c42f",
"operation": "images_upload_abort",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "25b1b11e-ef87-44b0-aee1-c5411141c42f"
}
{
"data": {
"requestId": "25b1b11e-ef87-44b0-aee1-c5411141c42f",
"operation": "images_upload_abort",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "25b1b11e-ef87-44b0-aee1-c5411141c42f"
}
结果字段
| 字段 | 说明 |
|---|---|
data.success | 成功中止或不存在活动会话时始终为 true。 |
恢复并轮询此请求
即使连接丢失，也应使用同一标识符。如果 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":"25b1b11e-ef87-44b0-aee1-c5411141c42f","operation":"images_upload_abort"}'
HTTP 200
{
"data": {
"requestId": "25b1b11e-ef87-44b0-aee1-c5411141c42f",
"operation": "images_upload_abort",
"status": "completed",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"resultStored": true,
"result": {
"success": true
}
}
}
操作说明
- 需要 images:write；无需额外的上传权限范围。
- uploadId 必须为 UUID。已连接用户拥有的活动上传会被中止，其会话会被移除。未知、已过期、已中止或已完成的会话会返回 success: true。
- 此操作取消尚未完成的分片上传。上传完成并移除会话后，中止操作不会删除已完成上传的参考文件。
- 只能对属于已连接用户的上传进行签名、完成或中止。这些别名仅接受不超过 8 MiB 的 JPG、PNG 和 WebP 会话，即使会话是通过其他上传系列创建的也如此。
- 请使用 UUID v4 requestId 或 HTTP Idempotency-Key 标头，并在重试时以完全相同的输入重复使用。集成层会记录每次变更，并返回其已记录的状态或结果，不会重新执行。失败或中断的请求不会自动重试。
- 其他用户拥有的会话处于活动状态时，不允许中止该会话。此操作不返回文件键或过期时间。
用量
每次成功调用消耗一次月度 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 | UPLOAD_TYPE_NOT_ALLOWED | 活动上传会话的图片类型不受支持或超过 8 MiB。 |
| 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 | UNAUTHORIZED | 活动上传会话属于另一位用户。 |
| 401 | USER_NOT_FOUND | 该凭据对应的账户已不存在。 |
| 403 | ACCOUNT_UNAVAILABLE | 调用者账户或计费账户不可用，或正在删除。 |
| 403 | AMBIGUOUS_TEAM_API_KEY | 此凭据对应的用户属于多个团队，因此计费上下文不明确。 |
| 403 | INSUFFICIENT_SCOPE | 请授予全部所需权限，或选择其他凭据。 |
| 403 | INTEGRATION_PLAN_UNSUPPORTED | 无法验证该账户的集成限制。 |
| 403 | SUBSCRIPTION_REQUIRED | 请使用有效的付费订阅。 |
| 403 | TEAM_OWNER_NOT_FOUND | 找不到实际生效的团队所有者账户。 |
| 409 | CONCURRENT_ACTION_LIMIT_REACHED | 此账户已有 10 个集成操作正在运行。请先轮询现有请求，再启动另一个操作。 |
| 409 | IDEMPOTENCY_CONFLICT | 该请求标识符已用于不同参数；请求头与请求体中的标识符不一致时，也会返回相同代码及 HTTP 400。 |
| 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 | 服务器正在重启。请稍后重试；对于修改操作，请保持请求标识符不变。 |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["images:write"]
}
}
此页面对您有帮助吗？