> ## 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. # 完成参考图像上传 > 使用 PUT 请求的分片编号和 ETag 完成当前账户拥有的参考图像上传。会验证已存储文件的大小。请将返回的 fileKey 用作生成参考图像。 使用 PUT 请求的分片编号和 ETag 完成当前账户拥有的参考图像上传。会验证已存储文件的大小。请将返回的 fileKey 用作生成参考图像。 ```http theme={null} POST https://api.voicecheap.ai/v1/actions/images_upload_complete ``` ## 身份验证和权限 在此请求头中发送 VoiceCheap API 密钥。也支持通过 Authorization: Bearer 发送同一 API 密钥。OAuth 访问令牌仅适用于 MCP，此 REST 端点不接受 OAuth 访问令牌。 所需权限: `images:write`. 需要有效的付费订阅。权限不会改变团队角色、资源归属、媒体额度或套餐限制。 ## 参数 在传输层可选：如果省略，服务器会在验证前注入标识符。请自行提供稳定的 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}$`. 此领域的 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)$`. 值列表。项目结构请参阅完整输入架构。 最少项目数: 1. 最多项目数: 2. 以下 JSON Schema 保留了发现接口公开的确切字段名、嵌套类型、默认值、范围和可接受值。其他跨字段规则列于操作说明中。 ```json theme={null} { "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." }, "parts": { "minItems": 1, "maxItems": 2, "type": "array", "items": { "type": "object", "properties": { "partNumber": { "type": "integer", "minimum": 1, "maximum": 2 }, "etag": { "type": "string", "minLength": 1, "maxLength": 256 } }, "required": ["partNumber", "etag"], "additionalProperties": false } } }, "required": ["uploadId", "parts"], "additionalProperties": false } ``` ## 幂等性 为每次修改操作在 requestId 或 Idempotency-Key HTTP 请求头中提供 UUID v4。网络故障后，请使用相同标识符和完全相同的参数重试。如果同时提供这两个值，它们必须一致。重放已保存的请求不会重复执行操作，也不会再次扣除月度调用次数。失败或中断的请求不会自动重新执行。 对于每次修改操作，如果重试时发现同一请求仍在运行，即使首次执行通常为同步操作，也可能返回 HTTP 202。如果执行已完成但 resultStored 为 false，重试会返回 HTTP 200 和已保存的请求状态，而非原始结果。请通过对应领域的历史记录、结果或下载操作获取输出。 ## 请求示例 请将示例资源标识符和媒体键替换为账户返回的值。重试同一次修改操作时，请保持请求标识符不变。 ```bash cURL theme={null} curl --request POST 'https://api.voicecheap.ai/v1/actions/images_upload_complete' \ --header "x-api-key: $VOICECHEAP_API_KEY" \ --header 'Content-Type: application/json' \ --data '{"requestId":"b7d73225-716b-45ec-ae43-559cfb3b6412","uploadId":"c547fb7f-f334-46a8-a8bb-80b5b343889a","parts":[{"partNumber":1,"etag":"\"d41d8cd98f00b204e9800998ecf8427e\""},{"partNumber":2,"etag":"\"0cc175b9c0f1b6a831c399e269772661\""}]}' ``` ```javascript JavaScript theme={null} const input = { requestId: 'b7d73225-716b-45ec-ae43-559cfb3b6412', uploadId: 'c547fb7f-f334-46a8-a8bb-80b5b343889a', parts: [ { partNumber: 1, etag: '"d41d8cd98f00b204e9800998ecf8427e"', }, { partNumber: 2, etag: '"0cc175b9c0f1b6a831c399e269772661"', }, ], }; const response = await fetch('https://api.voicecheap.ai/v1/actions/images_upload_complete', { 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/images_upload_complete", headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]}, json={"requestId": "b7d73225-716b-45ec-ae43-559cfb3b6412", "uploadId": "c547fb7f-f334-46a8-a8bb-80b5b343889a", "parts": [{"partNumber": 1, "etag": "\"d41d8cd98f00b204e9800998ecf8427e\""}, {"partNumber": 2, "etag": "\"0cc175b9c0f1b6a831c399e269772661\""}]}, timeout=120, ) body = response.json() if not response.ok: raise RuntimeError(f"{body.get('code')}: {body.get('message')}") print(body) ``` ## 响应 首次执行成功时返回 HTTP 200，操作结果位于 data 下。重放请求时可能改为返回已保存的请求状态。示例展示了一种支持的响应，并未包含所有可选字段。 已完成且当前账户拥有的参考文件键及其读取 URL，仅在存储字节长度与声明的文件大小完全一致后返回。生成参数应使用 fileKey，而非 readUrl。 ```json HTTP 200 theme={null} { "data": { "fileKey": "uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png", "readUrl": "https://media.example.com/uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png" }, "requestId": "b7d73225-716b-45ec-ae43-559cfb3b6412" } ``` ```json HTTP 202 replay_running theme={null} { "data": { "requestId": "b7d73225-716b-45ec-ae43-559cfb3b6412", "operation": "images_upload_complete", "createdAt": 1792144800000, "updatedAt": 1792144820000, "status": "running", "pollAfterSeconds": 5 }, "requestId": "b7d73225-716b-45ec-ae43-559cfb3b6412" } ``` ```json HTTP 200 replay_completed_without_result theme={null} { "data": { "requestId": "b7d73225-716b-45ec-ae43-559cfb3b6412", "operation": "images_upload_complete", "createdAt": 1792144800000, "updatedAt": 1792144820000, "status": "completed", "resultStored": false, "message": "The action completed. Retrieve its output from the corresponding history or resource action." }, "requestId": "b7d73225-716b-45ec-ae43-559cfb3b6412" } ``` ## 结果字段 | 字段 | 说明 | | - | - | | `data.fileKey` | 已完成上传且当前账户拥有的对象键，用作生成参考。 | | `data.readUrl` | 已上传参考对象的读取 URL。生成操作接受 fileKey，而非此 URL。 | ## 恢复并轮询此请求 即使连接丢失，也应使用同一标识符。如果 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":"b7d73225-716b-45ec-ae43-559cfb3b6412","operation":"images_upload_complete"}' ``` ```json HTTP 200 theme={null} { "data": { "requestId": "b7d73225-716b-45ec-ae43-559cfb3b6412", "operation": "images_upload_complete", "status": "completed", "createdAt": 1792144800000, "updatedAt": 1792144820000, "resultStored": true, "result": { "fileKey": "uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png", "readUrl": "https://media.example.com/uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png" } } } ``` ## 操作说明 * 需要 images:write；无需额外的上传权限范围。 * uploadId 是 initialize 返回的 UUID。parts 必须恰好包含会话所需的 1–2 个分片。每个分片都包含值为 1 至 2 的整数 partNumber，以及来自其成功 PUT 响应、长度为 1–256 个字符的 etag 字符串。 * 必须提供所有分片编号，且不得重复。完成上传前会对分片排序；ETag 会规范化为带引号的值。可以保留存储服务返回的 ETag 引号。 * 会将已完成对象的实际字节长度与 fileSize 和 8 MiB 上限进行核对。长度缺失、不匹配或超出上限时，会移除对象和活动会话，并返回 UPLOAD\_SIZE\_MISMATCH。 * 在 images\_generate 中将 fileKey 作为 referenceImageKey 传入。已完成上传的参考文件可由同一用户在后续图像或缩略图生成中重复使用；生成不会消耗参考文件。 * 只能对属于已连接用户的上传进行签名、完成或中止。这些别名仅接受不超过 8 MiB 的 JPG、PNG 和 WebP 会话，即使会话是通过其他上传系列创建的也如此。 * 生产环境的上传会话在 24 小时后过期。签名分片 URL 在一小时后过期。完成和中止操作会移除活动会话；此后 sign-parts 和 complete 均返回 Upload not found。这两类响应都不包含 expiresAt 字段。 * 请使用 UUID v4 requestId 或 HTTP Idempotency-Key 标头，并在重试时以完全相同的输入重复使用。集成层会记录每次变更，并返回其已记录的状态或结果，不会重新执行。失败或中断的请求不会自动重试。 * 完成操作会关闭多部分上传会话。使用原始 requestId 重试完成操作，可获取其已记录结果；针对已关闭的 uploadId 发起新的完成请求会返回 Upload not found。此操作不返回参考文件的保留到期时间。 ## 用量 每次成功调用消耗一次月度 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_SIZE_MISMATCH` | 无法获取已完成对象的存储大小、大小与 fileSize 不符，或大小超过 8 MiB；对象和会话均会被移除。 | | 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` | 服务器正在重启。请稍后重试；对于修改操作，请保持请求标识符不变。 | ```json theme={null} { "code": "INSUFFICIENT_SCOPE", "message": "This credential does not permit the requested action.", "status": 403, "details": { "requiredScopes": ["images:write"] } } ``` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.