curl --request POST 'https://api.voicecheap.ai/v1/actions/voices_upload_complete' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"uploadId":"a1b2c3d4-e5f6-4789-8abc-def012345678","parts":[{"partNumber":1,"etag":"0123456789abcdef0123456789abcdef"}],"requestId":"13579bdf-2468-4ace-8bdf-0123456789ab"}'
const input = {
uploadId: 'a1b2c3d4-e5f6-4789-8abc-def012345678',
parts: [
{
partNumber: 1,
etag: '0123456789abcdef0123456789abcdef',
},
],
requestId: '13579bdf-2468-4ace-8bdf-0123456789ab',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/voices_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/voices_upload_complete",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"uploadId": "a1b2c3d4-e5f6-4789-8abc-def012345678", "parts": [{"partNumber": 1, "etag": "0123456789abcdef0123456789abcdef"}], "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"fileKey": "uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-voice-sample.wav",
"readUrl": "https://media.example.com/uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-voice-sample.wav"
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "voices_upload_complete",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "voices_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": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
読み上げ音声
メディアのアップロードを完了（音声サンプル）
アップロード済みパートを確定し、生成アクションで使用する、ご自身が所有する fileKey を取得します。
POST
/
v1
/
actions
/
voices_upload_complete
curl --request POST 'https://api.voicecheap.ai/v1/actions/voices_upload_complete' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"uploadId":"a1b2c3d4-e5f6-4789-8abc-def012345678","parts":[{"partNumber":1,"etag":"0123456789abcdef0123456789abcdef"}],"requestId":"13579bdf-2468-4ace-8bdf-0123456789ab"}'
const input = {
uploadId: 'a1b2c3d4-e5f6-4789-8abc-def012345678',
parts: [
{
partNumber: 1,
etag: '0123456789abcdef0123456789abcdef',
},
],
requestId: '13579bdf-2468-4ace-8bdf-0123456789ab',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/voices_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/voices_upload_complete",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"uploadId": "a1b2c3d4-e5f6-4789-8abc-def012345678", "parts": [{"partNumber": 1, "etag": "0123456789abcdef0123456789abcdef"}], "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"fileKey": "uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-voice-sample.wav",
"readUrl": "https://media.example.com/uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-voice-sample.wav"
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "voices_upload_complete",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "voices_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": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
アップロード済みパートを確定し、生成アクションで使用する、ご自身が所有する fileKey を取得します。
必要な権限:
POST https://api.voicecheap.ai/v1/actions/voices_upload_complete
認証と権限
string
必須
このヘッダーに VoiceCheap API キーを指定してください。同じ API キーを Authorization: Bearer で送信することもできます。OAuth アクセストークンは MCP
でのみ使用でき、この REST エンドポイントでは使用できません。
voices:write.
有効な有料サブスクリプションが必要です。権限によってチーム内のロール、リソースの所有権、メディアクレジット、プランの制限が変わることはありません。
パラメーター
string
必須
テキスト値。形式: “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. 最大要素数: 10000.
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}$.完全な入力スキーマ
完全な入力スキーマ
以下の JSON Schema は、ディスカバリーで公開される正確なフィールド名、ネストされた型、デフォルト値、範囲、許容値を保持しています。フィールド間の追加ルールは操作の注意事項に記載されています。
{
"type": "object",
"properties": {
"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)$"
},
"parts": {
"minItems": 1,
"maxItems": 10000,
"type": "array",
"items": {
"type": "object",
"properties": {
"partNumber": {
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"etag": {
"type": "string",
"minLength": 1,
"maxLength": 512,
"pattern": "^[^\\r\\n]+$"
}
},
"required": ["partNumber", "etag"],
"additionalProperties": false
}
},
"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}$"
}
},
"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/voices_upload_complete' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"uploadId":"a1b2c3d4-e5f6-4789-8abc-def012345678","parts":[{"partNumber":1,"etag":"0123456789abcdef0123456789abcdef"}],"requestId":"13579bdf-2468-4ace-8bdf-0123456789ab"}'
const input = {
uploadId: 'a1b2c3d4-e5f6-4789-8abc-def012345678',
parts: [
{
partNumber: 1,
etag: '0123456789abcdef0123456789abcdef',
},
],
requestId: '13579bdf-2468-4ace-8bdf-0123456789ab',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/voices_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/voices_upload_complete",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"uploadId": "a1b2c3d4-e5f6-4789-8abc-def012345678", "parts": [{"partNumber": 1, "etag": "0123456789abcdef0123456789abcdef"}], "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
レスポンス
初回実行が成功すると、操作結果を data に格納して HTTP 200 を返します。同じリクエストを再送した場合は、代わりに保存済みリクエストの状態を返すことがあります。例はサポートされるレスポンスの一例であり、すべての任意フィールドを示すものではありません。 所有する完了済みの fileKey と、メディア読み取り URL。fileKey を次の生成または音声アクションに渡してください。{
"data": {
"fileKey": "uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-voice-sample.wav",
"readUrl": "https://media.example.com/uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-voice-sample.wav"
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "voices_upload_complete",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "voices_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": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
結果フィールド
| フィールド | 説明 |
|---|---|
data.fileKey | 生成アクションと音声アクションで使用する、所有する完了済みアップロードへの参照。 |
data.readUrl | completed のソースファイルに対して返される読み取り URL。非公開メディアへのアクセス情報として扱ってください。 |
リクエストの復旧とポーリング
接続が切断された後も同じ識別子を使用してください。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":"13579bdf-2468-4ace-8bdf-0123456789ab","operation":"voices_upload_complete"}'
HTTP 200
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "voices_upload_complete",
"status": "completed",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"resultStored": true,
"result": {
"fileKey": "uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-voice-sample.wav",
"readUrl": "https://media.example.com/uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-voice-sample.wav"
}
}
}
操作の注意事項
- 有料サブスクリプションとアクションの権限が必要です。実行時に、実行者の個人向けツールプランが再確認されます。認証情報がチームに関連付けられていても、保存済みツールとアップロード参照はその実行者に属します。
- 成功したアクションは、API/MCP 共通の月間呼び出し枠を1回消費します。月間上限は Beginner が 500 回、Starter が 5,000 回、Creator が 25,000 回で、Pro、Scale、Enterprise に月間上限はありません。毎分の上限はそれぞれ 30、60、120、180、300、600 回で、引き続き適用されます。ツールの生成枠は別です。
- UUID v4 の requestId、またはそれと同じ値の Idempotency-Key ヘッダーを使用し、再試行時もアクション、ID、引数を変えないでください。キャッシュからの再応答は、月間呼び出し枠を追加消費しません。
- アップロードのプレフィックスによって必要な権限が決まります。tools は transcription:write、subtitles は subtitles:write、projects は projects:write、voices は voices:write を使用します。
- 音声サンプルは MP3、WAV、M4A、OGG、Opus の音声のみ対応し、20 MiB（20,971,520 bytes）以内です。MIME タイプは、記載されている音声タイプのいずれかである必要があります。kind のデフォルトは voice_sample です。このアクション群には upload_import はありません。
- 完了済みサンプルの fileKey を、該当する音声作成アクションで使用してください。アップロードだけでは音声の作成や読み上げの生成は行われません。
- 音声アップロードの署名、完了、中止でも、既存セッションが音声であり 20 MiB 以下であることを確認します。この権限で、無関係な大容量セッションや動画セッションは使用できません。
- アップロードした各パートを、その PUT が返した ETag とともに、必ず1回ずつ送信してください。確定処理の前にパートは partNumber 順に並べ替えられます。ETag を囲む引用符はあってもなくても構いません。
- 正常に完了すると、アクティブなセッションは削除されます。レスポンスを受信できなかった場合は、同じ requestId を再利用して結果を復元してください。消費済みのセッションに新しい完了リクエストを送信しないでください。
- アップロードの完了では、1日の生成利用枠を消費しません。メディア使用量は、別途行う生成処理で決まります。
使用量
正常に実行された呼び出しごとに、月間 API/MCP 呼び出し回数を 1 回消費します。メディアクレジットと、その操作固有の生成枠も適用されます。エラー
| HTTP ステータス | コード | 意味または対処方法 |
|---|---|---|
| 400 | BAD_REQUEST | パートが不足、重複、または範囲外です。各パートを過不足なく1回ずつ指定してください。 |
| 400 | CREDENTIAL_IN_QUERY | access_token または api_key クエリパラメーターに認証情報が指定されています。認証情報はヘッダーで送信してください。 |
| 400 | IDEMPOTENCY_CONFLICT | ヘッダーと本文のリクエスト ID が一致しません。 |
| 400 | INVALID_REQUEST_ID | requestId または Idempotency-Key が UUID v4 ではありません。 |
| 400 | UPLOAD_SIZE_MISMATCH | 保存済みバイト数が申告された fileSize と異なるか、20 MiB を超えています。無効なオブジェクトとアップロードセッションは破棄されます。 |
| 400 | UPLOAD_TYPE_NOT_ALLOWED | 所有するセッションが 20 MiB を超えているか、その MIME タイプが音声サンプルに許可された音声形式ではありません。 |
| 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 | APIキーまたはMCP接続に、必要なアクション権限がありません。 |
| 403 | INTEGRATION_PLAN_UNSUPPORTED | アカウントの連携上限を確認できませんでした。 |
| 403 | PAID_SUBSCRIPTION_REQUIRED | このツールアクションの実行時点で、認証済み実行者の有料サブスクリプションが有効ではありません。 |
| 403 | SUBSCRIPTION_REQUIRED | 有効な有料サブスクリプションを使用してください。 |
| 403 | TEAM_OWNER_NOT_FOUND | 実効的なチームオーナーのアカウントが見つかりませんでした。 |
| 404 | NOT_FOUND | アップロードセッションが存在しない、期限切れ、完了済み、または中止済みです。 |
| 409 | CONCURRENT_ACTION_LIMIT_REACHED | このアカウントでは、すでに 10 件の連携アクションが実行中です。新しいアクションを開始する前に、既存のリクエストをポーリングしてください。 |
| 409 | IDEMPOTENCY_CONFLICT | 識別子を再利用する場合は、同じ操作と引数でのみ使用してください。 |
| 429 | INTEGRATION_MONTHLY_LIMIT_REACHED | 使用済みと処理待ちの呼び出し数が、共有の月間 API/MCP 利用枠に達しました。 |
| 429 | INTEGRATION_RATE_LIMIT_REACHED | アカウントの毎分の連携上限に達しています。retryAfterSeconds を確認してください。 |
| 500 | INTERNAL_ERROR | 変更操作を再試行するか判断する前に、保存済みリクエストの状態とリソースの履歴を確認してください。 |
| 503 | ACTION_RESULT_UNAVAILABLE | アクションは実行されましたが、リクエスト結果の永続保存を確認できませんでした。別の書き込みを開始する前に、同じアクションと requestId をポーリングし、リソースの履歴を確認してください。 |
| 503 | INTERNAL_ERROR | アップロードセッションサービスを利用できません。書き込みを再試行する前に、元のリクエストを確認してください。 |
| 503 | SERVER_RESTARTING | サーバーが再起動中です。少し待ってから再試行し、変更操作では同じリクエスト識別子を使用してください。 |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["voices:write"]
}
}
このページは役に立ちましたか？