> ## 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. # 参照画像のアップロードを初期化 > 最大 8 MiB の JPG、PNG、WebP 参照画像のアップロードを準備します。images_upload_sign_parts で PUT URL を取得し、バイトデータをアップロードしてから images_upload_complete を呼び出します。生成時には、その fileKey を使用してください。 最大 8 MiB の JPG、PNG、WebP 参照画像のアップロードを準備します。images\_upload\_sign\_parts で PUT URL を取得し、バイトデータをアップロードしてから images\_upload\_complete を呼び出します。生成時には、その fileKey を使用してください。 ```http theme={null} POST https://api.voicecheap.ai/v1/actions/images_upload_initialize ``` ## 認証と権限 このヘッダーに VoiceCheap API キーを指定してください。同じ API キーを Authorization: Bearer で送信することもできます。OAuth アクセストークンは MCP でのみ使用でき、この REST エンドポイントでは使用できません。 必要な権限: `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}$`. contentType と一致する拡張子を持つ画像ファイル名。 最小文字数: 1. 最大文字数: 250. パターン: `\.(?:jpe?g|png|webp)$`. テキスト値。 許容値: "image/jpeg", "image/png", "image/webp". 正確なファイルサイズ（バイト）。最大 8 MiB。 最小値: 1. 最大値: 8388608. 以下の 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}$" }, "filename": { "type": "string", "minLength": 1, "maxLength": 250, "pattern": "\\.(?:jpe?g|png|webp)$", "description": "The image filename, with an extension matching contentType." }, "contentType": { "type": "string", "enum": ["image/jpeg", "image/png", "image/webp"] }, "fileSize": { "type": "integer", "minimum": 1, "maximum": 8388608, "description": "Exact file size in bytes, up to 8 MiB." } }, "required": ["filename", "contentType", "fileSize"], "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_initialize' \ --header "x-api-key: $VOICECHEAP_API_KEY" \ --header 'Content-Type: application/json' \ --data '{"requestId":"85d80887-5e1c-4a86-bbad-bb105487f7e4","filename":"reference.png","contentType":"image/png","fileSize":7340032}' ``` ```javascript JavaScript theme={null} const input = { requestId: '85d80887-5e1c-4a86-bbad-bb105487f7e4', filename: 'reference.png', contentType: 'image/png', fileSize: 7340032, }; const response = await fetch('https://api.voicecheap.ai/v1/actions/images_upload_initialize', { 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_initialize", headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]}, json={"requestId": "85d80887-5e1c-4a86-bbad-bb105487f7e4", "filename": "reference.png", "contentType": "image/png", "fileSize": 7340032}, timeout=120, ) body = response.json() if not response.ok: raise RuntimeError(f"{body.get('code')}: {body.get('message')}") print(body) ``` ## レスポンス 初回実行が成功すると、操作結果を data に格納して HTTP 200 を返します。同じリクエストを再送した場合は、代わりに保存済みリクエストの状態を返すことがあります。例はサポートされるレスポンスの一例であり、すべての任意フィールドを示すものではありません。 新しい参照画像用マルチパートアップロードセッション、将来のオブジェクトキー、パートサイズ（バイト）、最大並列アップロード数。この時点では画像のバイトデータはアップロードされず、key も生成に使用できる状態にはなりません。 ```json HTTP 200 theme={null} { "data": { "uploadId": "c547fb7f-f334-46a8-a8bb-80b5b343889a", "key": "uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png", "partSize": 5242880, "maxConcurrency": 4 }, "requestId": "85d80887-5e1c-4a86-bbad-bb105487f7e4" } ``` ```json HTTP 202 replay_running theme={null} { "data": { "requestId": "85d80887-5e1c-4a86-bbad-bb105487f7e4", "operation": "images_upload_initialize", "createdAt": 1792144800000, "updatedAt": 1792144820000, "status": "running", "pollAfterSeconds": 5 }, "requestId": "85d80887-5e1c-4a86-bbad-bb105487f7e4" } ``` ```json HTTP 200 replay_completed_without_result theme={null} { "data": { "requestId": "85d80887-5e1c-4a86-bbad-bb105487f7e4", "operation": "images_upload_initialize", "createdAt": 1792144800000, "updatedAt": 1792144820000, "status": "completed", "resultStored": false, "message": "The action completed. Retrieve its output from the corresponding history or resource action." }, "requestId": "85d80887-5e1c-4a86-bbad-bb105487f7e4" } ``` ## 結果フィールド | フィールド | 説明 | | - | - | | `data.uploadId` | アクティブなアップロードセッションを識別するUUID。以降のアップロードアクションに渡してください。 | | `data.key` | 今後所有することになるオブジェクトのキー。生成の参照には、正常に完了した際の fileKey を使用してください。 | | `data.partSize` | 必要なパートサイズ（バイト）。最終パートのみ、残りのバイトを含みます。 | | `data.maxConcurrency` | パートの並列アップロード数の推奨上限：4。 | ## リクエストの復旧とポーリング 接続が切断された後も同じ識別子を使用してください。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":"85d80887-5e1c-4a86-bbad-bb105487f7e4","operation":"images_upload_initialize"}' ``` ```json HTTP 200 theme={null} { "data": { "requestId": "85d80887-5e1c-4a86-bbad-bb105487f7e4", "operation": "images_upload_initialize", "status": "completed", "createdAt": 1792144800000, "updatedAt": 1792144820000, "resultStored": true, "result": { "uploadId": "c547fb7f-f334-46a8-a8bb-80b5b343889a", "key": "uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png", "partSize": 5242880, "maxConcurrency": 4 } } } ``` ## 操作の注意事項 * images:write が必要です。追加のアップロードスコープは不要です。 * filename は前後の空白が除去され、1–250 文字で、末尾が .jpg、.jpeg、.png、.webp のいずれかである必要があります。拡張子は contentType の image/jpeg、image/png、image/webp と一致する必要があります。fileSize は正確なバイト数を表す 1–8,388,608 の整数です。 * 共有アップロード実装は、これらの参照画像に対して partSize 5 MiB（5,242,880 バイト）を返します。5 MiB 以下のファイルは 1 パート、それを超えて 8 MiB 以下のファイルは 2 パートを使用します。images\_upload\_sign\_parts で PUT URL を取得し、バイナリデータをアップロードしてから images\_upload\_complete を呼び出してください。 * 完了操作が返す fileKey を、images\_generate の referenceImageKey として使用してください。initialize の結果は fileKey ではなく key を使用します。完了前に key を生成へ渡さないでください。 * 本番環境のアップロードセッションは24時間後に期限切れになります。署名付きパートURLの有効期間は1時間です。完了と中止はアクティブなセッションを削除するため、その後の sign-parts と complete は Upload not found を返します。どちらのレスポンスにも expiresAt フィールドは含まれません。 * 認証情報がチームのコンテキストで接続されている場合も、このアクションは接続ユーザー自身の作成物とアップロードを使用します。 * UUID v4 の requestId、または HTTP の Idempotency-Key ヘッダーを使用し、再試行時は同一の入力で再利用してください。連携レイヤーは各変更を記録し、再実行せずに記録済みの状態または結果を返します。failed または interrupted のリクエストは、自動的には再試行されません。 * オブジェクトキー内のファイル名は安全な形式に処理され、短縮される場合があります。返された key と uploadId をそのまま保持し、自分で組み立てないでください。アップロード時の申告サイズと種類の検証に加え、生成時にも画像バイト列を検証します。 ## 使用量 正常に実行された呼び出しごとに、月間 API/MCP 呼び出し回数を 1 回消費します。メディアクレジットと、その操作固有の生成枠も適用されます。 ## エラー | 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 | `REFERENCE_IMAGE_INVALID` | ファイル名の拡張子が、宣言された画像の contentType と一致しません。 | | 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 | `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` | サーバーが再起動中です。少し待ってから再試行し、変更操作では同じリクエスト識別子を使用してください。 | ```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.