参照画像のアップロードを完了

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\""}]}'

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);

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)

{
  "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"
}

{
  "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"
}

{
  "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"
}

POST

actions

images_upload_complete

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\""}]}'

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);

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)

{
  "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"
}

{
  "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"
}

{
  "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"
}

PUT リクエストのパート番号と ETags を使用し、ご自身が所有する参照画像のアップロードを完了します。保存済みファイルのサイズを検証します。返された fileKey を生成時の参照に使用してください。

POST https://api.voicecheap.ai/v1/actions/images_upload_complete

認証と権限

string

必須

このヘッダーに VoiceCheap API キーを指定してください。同じ API キーを Authorization: Bearer で送信することもできます。OAuth アクセストークンは MCP でのみ使用でき、この REST エンドポイントでは使用できません。

必要な権限: 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."
    },
    "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 で返します。出力は対応するドメインの履歴、結果、またはダウンロードアクションで取得してください。

リクエスト例

例に記載されたリソース識別子とメディアキーを、ご自身のアカウントで返された値に置き換えてください。同じ変更操作を再試行する場合は、リクエスト識別子を変更しないでください。

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\""}]}'

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);

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)

レスポンス

初回実行が成功すると、操作結果を data に格納して HTTP 200 を返します。同じリクエストを再送した場合は、代わりに保存済みリクエストの状態を返すことがあります。例はサポートされるレスポンスの一例であり、すべての任意フィールドを示すものではありません。 completed の所有済み参照ファイルのキーと読み取り URL。保存済みバイト数が申告されたファイルサイズと完全に一致した場合にのみ返されます。生成引数には readUrl ではなく fileKey を使用してください。

{
  "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"
}

{
  "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"
}

{
  "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。生成アクションには、このURLではなく fileKey を渡します。

リクエストの復旧とポーリング

接続が切断された後も同じ識別子を使用してください。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":"b7d73225-716b-45ec-ae43-559cfb3b6412","operation":"images_upload_complete"}'

HTTP 200

{
  "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の有効期間は1時間です。完了と中止はアクティブなセッションを削除するため、その後の sign-parts と complete は Upload not found を返します。どちらのレスポンスにも expiresAt フィールドは含まれません。
UUID v4 の requestId、または HTTP の Idempotency-Key ヘッダーを使用し、再試行時は同一の入力で再利用してください。連携レイヤーは各変更を記録し、再実行せずに記録済みの状態または結果を返します。failed または interrupted のリクエストは、自動的には再試行されません。
完了操作によりマルチパートセッションは閉じられます。記録済みの結果を取得するには、元の requestId で完了操作を再試行してください。閉じられた uploadId に新しい完了リクエストを送ると Upload not found が返されます。このアクションは参照ファイルの保持期限を返しません。

使用量

正常に実行された呼び出しごとに、月間 API/MCP 呼び出し回数を 1 回消費します。メディアクレジットと、その操作固有の生成枠も適用されます。

エラー

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`	サーバーが再起動中です。少し待ってから再試行し、変更操作では同じリクエスト識別子を使用してください。

{
  "code": "INSUFFICIENT_SCOPE",
  "message": "This credential does not permit the requested action.",
  "status": 403,
  "details": {
    "requiredScopes": ["images:write"]
  }
}

概要

ディスカバリー

アカウント

使用量とアクティビティ

設定と通知

チーム

プロジェクト

翻訳と吹き替え

文字起こしと編集

テキスト読み上げ

読み上げ音声

吹き替え音声

文字起こし

字幕とキャプション

画像

サムネイル

フォルダー

用語集

Webhook

公開

リクエストの状態

OAuth と MCP プロトコル

参照画像のアップロードを完了

認証と権限

パラメーター

冪等性

リクエスト例

レスポンス

結果フィールド

リクエストの復旧とポーリング

操作の注意事項

使用量

エラー

​認証と権限

​パラメーター

​冪等性

​リクエスト例

​レスポンス

​結果フィールド

​リクエストの復旧とポーリング

​操作の注意事項

​使用量

​エラー

認証と権限

パラメーター

冪等性

リクエスト例

レスポンス

結果フィールド

リクエストの復旧とポーリング

操作の注意事項

使用量

エラー