curl --request POST 'https://api.voicecheap.ai/v1/actions/images_upload_sign_parts' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"8d16d4dc-a1a1-45bc-8f9c-75612ea7561f","uploadId":"c547fb7f-f334-46a8-a8bb-80b5b343889a","partNumbers":[1,2]}'
const input = {
requestId: '8d16d4dc-a1a1-45bc-8f9c-75612ea7561f',
uploadId: 'c547fb7f-f334-46a8-a8bb-80b5b343889a',
partNumbers: [1, 2],
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/images_upload_sign_parts', {
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_sign_parts",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "8d16d4dc-a1a1-45bc-8f9c-75612ea7561f", "uploadId": "c547fb7f-f334-46a8-a8bb-80b5b343889a", "partNumbers": [1, 2]},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"presignedUrls": [
{
"partNumber": 1,
"url": "https://uploads.example.com/uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png?partNumber=1&uploadId=example-upload&signature=example-signature"
},
{
"partNumber": 2,
"url": "https://uploads.example.com/uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png?partNumber=2&uploadId=example-upload&signature=example-signature"
}
]
},
"requestId": "8d16d4dc-a1a1-45bc-8f9c-75612ea7561f"
}
{
"data": {
"requestId": "8d16d4dc-a1a1-45bc-8f9c-75612ea7561f",
"operation": "images_upload_sign_parts",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "8d16d4dc-a1a1-45bc-8f9c-75612ea7561f"
}
{
"data": {
"requestId": "8d16d4dc-a1a1-45bc-8f9c-75612ea7561f",
"operation": "images_upload_sign_parts",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "8d16d4dc-a1a1-45bc-8f9c-75612ea7561f"
}
图像
获取参考图像上传 URL
获取当前账户拥有的参考图像上传的签名 PUT URL。8 MiB 的图像最多有两个分片。请保存每个 PUT 返回的 ETag，供 upload_complete 使用。
POST
/
v1
/
actions
/
images_upload_sign_parts
curl --request POST 'https://api.voicecheap.ai/v1/actions/images_upload_sign_parts' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"8d16d4dc-a1a1-45bc-8f9c-75612ea7561f","uploadId":"c547fb7f-f334-46a8-a8bb-80b5b343889a","partNumbers":[1,2]}'
const input = {
requestId: '8d16d4dc-a1a1-45bc-8f9c-75612ea7561f',
uploadId: 'c547fb7f-f334-46a8-a8bb-80b5b343889a',
partNumbers: [1, 2],
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/images_upload_sign_parts', {
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_sign_parts",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "8d16d4dc-a1a1-45bc-8f9c-75612ea7561f", "uploadId": "c547fb7f-f334-46a8-a8bb-80b5b343889a", "partNumbers": [1, 2]},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"presignedUrls": [
{
"partNumber": 1,
"url": "https://uploads.example.com/uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png?partNumber=1&uploadId=example-upload&signature=example-signature"
},
{
"partNumber": 2,
"url": "https://uploads.example.com/uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png?partNumber=2&uploadId=example-upload&signature=example-signature"
}
]
},
"requestId": "8d16d4dc-a1a1-45bc-8f9c-75612ea7561f"
}
{
"data": {
"requestId": "8d16d4dc-a1a1-45bc-8f9c-75612ea7561f",
"operation": "images_upload_sign_parts",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "8d16d4dc-a1a1-45bc-8f9c-75612ea7561f"
}
{
"data": {
"requestId": "8d16d4dc-a1a1-45bc-8f9c-75612ea7561f",
"operation": "images_upload_sign_parts",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "8d16d4dc-a1a1-45bc-8f9c-75612ea7561f"
}
获取当前账户拥有的参考图像上传的签名 PUT URL。8 MiB 的图像最多有两个分片。请保存每个 PUT 返回的 ETag，供 upload_complete 使用。
所需权限:
POST https://api.voicecheap.ai/v1/actions/images_upload_sign_parts
身份验证和权限
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)$.array
必填
值列表。项目结构请参阅完整输入架构。最少项目数: 1. 最多项目数: 2.
完整输入架构
完整输入架构
以下 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."
},
"partNumbers": {
"minItems": 1,
"maxItems": 2,
"type": "array",
"items": {
"type": "integer",
"minimum": 1,
"maximum": 2
}
}
},
"required": ["uploadId", "partNumbers"],
"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_sign_parts' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"8d16d4dc-a1a1-45bc-8f9c-75612ea7561f","uploadId":"c547fb7f-f334-46a8-a8bb-80b5b343889a","partNumbers":[1,2]}'
const input = {
requestId: '8d16d4dc-a1a1-45bc-8f9c-75612ea7561f',
uploadId: 'c547fb7f-f334-46a8-a8bb-80b5b343889a',
partNumbers: [1, 2],
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/images_upload_sign_parts', {
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_sign_parts",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "8d16d4dc-a1a1-45bc-8f9c-75612ea7561f", "uploadId": "c547fb7f-f334-46a8-a8bb-80b5b343889a", "partNumbers": [1, 2]},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
响应
首次执行成功时返回 HTTP 200，操作结果位于 data 下。重放请求时可能改为返回已保存的请求状态。示例展示了一种支持的响应，并未包含所有可选字段。 临时签名 PUT URL 数组，每个不同的所请求分片编号对应一个 URL。响应不包含图像字节、ETags 或各分片的大小字段。{
"data": {
"presignedUrls": [
{
"partNumber": 1,
"url": "https://uploads.example.com/uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png?partNumber=1&uploadId=example-upload&signature=example-signature"
},
{
"partNumber": 2,
"url": "https://uploads.example.com/uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png?partNumber=2&uploadId=example-upload&signature=example-signature"
}
]
},
"requestId": "8d16d4dc-a1a1-45bc-8f9c-75612ea7561f"
}
{
"data": {
"requestId": "8d16d4dc-a1a1-45bc-8f9c-75612ea7561f",
"operation": "images_upload_sign_parts",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "8d16d4dc-a1a1-45bc-8f9c-75612ea7561f"
}
{
"data": {
"requestId": "8d16d4dc-a1a1-45bc-8f9c-75612ea7561f",
"operation": "images_upload_sign_parts",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "8d16d4dc-a1a1-45bc-8f9c-75612ea7561f"
}
结果字段
| 字段 | 说明 |
|---|---|
data.presignedUrls | 已签名的上传分片目标数组。 |
data.presignedUrls[].partNumber | 此 URL 对应的分片编号，从 1 开始。 |
data.presignedUrls[].url | 有效期为一小时的临时 PUT URL；请使用该分片签名中指定的准确 Content-Length。 |
恢复并轮询此请求
即使连接丢失，也应使用同一标识符。如果 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":"8d16d4dc-a1a1-45bc-8f9c-75612ea7561f","operation":"images_upload_sign_parts"}'
HTTP 200
{
"data": {
"requestId": "8d16d4dc-a1a1-45bc-8f9c-75612ea7561f",
"operation": "images_upload_sign_parts",
"status": "completed",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"resultStored": true,
"result": {
"presignedUrls": [
{
"partNumber": 1,
"url": "https://uploads.example.com/uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png?partNumber=1&uploadId=example-upload&signature=example-signature"
},
{
"partNumber": 2,
"url": "https://uploads.example.com/uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png?partNumber=2&uploadId=example-upload&signature=example-signature"
}
]
}
}
}
操作说明
- 需要 images:write；无需额外的上传权限范围。
- uploadId 是 initialize 返回的 UUID。partNumbers 包含 1–2 个整数，每个取值为 1 至 2，且每个分片都必须对应该会话声明的 fileSize。重复请求的分片编号会合并为一个 URL。
- 通过 PUT 将原始二进制分片字节上传至每个返回的 URL。Content-Length 已纳入签名，必须与 min(partSize, fileSize - (partNumber - 1) × partSize) 完全一致。在 7 MiB 的示例中，分片 1 为 5,242,880 字节，分片 2 为 2,097,152 字节。请勿向签名 URL 发送 JSON、multipart/form-data 或 base64。
- 保存每次成功 PUT 的 ETag 响应头，并将这些值发送给 images_upload_complete。请将签名 URL 视为私密的临时上传权限凭证。
- 只能对属于已连接用户的上传进行签名、完成或中止。这些别名仅接受不超过 8 MiB 的 JPG、PNG 和 WebP 会话，即使会话是通过其他上传系列创建的也如此。
- 生产环境的上传会话在 24 小时后过期。签名分片 URL 在一小时后过期。完成和中止操作会移除活动会话；此后 sign-parts 和 complete 均返回 Upload not found。这两类响应都不包含 expiresAt 字段。
- 请使用 UUID v4 requestId 或 HTTP Idempotency-Key 标头，并在重试时以完全相同的输入重复使用。集成层会记录每次变更，并返回其已记录的状态或结果，不会重新执行。失败或中断的请求不会自动重试。
- URL 在一小时后过期时，如会话仍然有效，请使用新的 requestId 调用 sign-parts 获取新 URL。重试同一 requestId 会返回其已保存的结果，包括旧 URL。
用量
每次成功调用消耗一次月度 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 | 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 | 找不到实际生效的团队所有者账户。 |
| 404 | 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"]
}
}
此页面对您有帮助吗？