> ## 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.
# クローン音声をプレビュー
> 明示的な許可を得た、ご自身が所有する 1～3 件の音声アップロードから、一時的なクローン音声プレビューを作成します。アプリのクローン試用枠が適用されます。保持するには、有効期限内に選択したプレビューを保存してください。
明示的な許可を得た、ご自身が所有する 1～3 件の音声アップロードから、一時的なクローン音声プレビューを作成します。アプリのクローン試用枠が適用されます。保持するには、有効期限内に選択したプレビューを保存してください。
```http theme={null}
POST https://api.voicecheap.ai/v1/actions/voices_preview_clone
```
## 認証と権限
このヘッダーに VoiceCheap API キーを指定してください。同じ API キーを Authorization: Bearer で送信することもできます。OAuth アクセストークンは MCP
でのみ使用でき、この REST エンドポイントでは使用できません。
必要な権限: `voices: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}$`.
テキスト値。
最小文字数: 1. 最大文字数: 80.
値のリスト。要素の構造は完全な入力スキーマを参照してください。
最小要素数: 1. 最大要素数: 3.
すべてのサンプルに含まれる声の人物について、クローンを作成する権限があることを確認してください。
必須の値: true.
真偽値。
デフォルト値: false.
テキスト値。
最大文字数: 35. パターン: `^[a-z]{2,3}(-[A-Za-z0-9]{2,8})*$`.
以下の 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}$"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"samples": {
"minItems": 1,
"maxItems": 3,
"type": "array",
"items": {
"type": "object",
"properties": {
"fileKey": {
"type": "string",
"minLength": 1,
"maxLength": 1024,
"description": "An uploaded audio fileKey returned by voices_upload_complete for this account."
}
},
"required": ["fileKey"],
"additionalProperties": false
}
},
"hasPermission": {
"type": "boolean",
"const": true,
"description": "Confirm that you have permission to clone the person whose voice is in every sample."
},
"trimToMaxDuration": {
"default": false,
"type": "boolean"
},
"language": {
"type": "string",
"maxLength": 35,
"pattern": "^[a-z]{2,3}(-[A-Za-z0-9]{2,8})*$"
}
},
"required": ["name", "samples", "hasPermission"],
"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/voices_preview_clone' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"284a861a-4da8-4d67-ad48-8123e76c8e91","name":"Studio narrator","samples":[{"fileKey":"uploads/example-user/66666666-6666-4666-8666-666666666666-narrator.wav"}],"hasPermission":true,"trimToMaxDuration":false,"language":"en"}'
```
```javascript JavaScript theme={null}
const input = {
requestId: '284a861a-4da8-4d67-ad48-8123e76c8e91',
name: 'Studio narrator',
samples: [
{
fileKey: 'uploads/example-user/66666666-6666-4666-8666-666666666666-narrator.wav',
},
],
hasPermission: true,
trimToMaxDuration: false,
language: 'en',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/voices_preview_clone', {
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/voices_preview_clone",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "name": "Studio narrator", "samples": [{"fileKey": "uploads/example-user/66666666-6666-4666-8666-666666666666-narrator.wav"}], "hasPermission": True, "trimToMaxDuration": False, "language": "en"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
```
## レスポンス
この操作は実行中に HTTP 202 を返します。requestId を保存し、その識別子と元の操作名を指定して action\_request\_get をポーリングしてください。ポーリングの状態は running、completed、failed、interrupted です。完了した結果が別のメディアジョブを示す場合は、その操作に対応するステータスまたは出力取得アクションで処理を続けてください。
新しいクローン候補を含む、すべてのアクティブな未保存音声プレビューと更新後の作成利用枠。
```json HTTP 202 theme={null}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"status": "running",
"pollAction": "action_request_get",
"pollAfterSeconds": 5
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
```
```json HTTP 200 theme={null}
{
"data": {
"voicePreviews": [
{
"id": "44444444-4444-4444-8444-444444444444",
"kind": "clone",
"name": "Studio narrator",
"previewUrl": "https://files.example.com/narrator-preview.mp3",
"expiresAt": 1792238400000,
"durationSeconds": 10
}
],
"creationUsage": {
"cloneTrial": {
"limit": 1,
"used": 1,
"remaining": 0
},
"design": {
"limit": 5,
"used": 0,
"remaining": 5,
"resetsAt": 1792195200000
},
"previewExpiresAfterHours": 24
}
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
```
```json HTTP 202 replay_running theme={null}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"operation": "voices_preview_clone",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
```
```json HTTP 200 replay_completed_without_result theme={null}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"operation": "voices_preview_clone",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
```
## 結果フィールド
| フィールド | 説明 |
| - | - |
| `data.voicePreviews` | 以前のリクエストの候補も含む、このアカウントの現在有効な未保存プレビューすべて。 |
| `data.voicePreviews[].id` | voices\_preview\_get と voices\_save\_preview で使用するプレビューの UUID v4。 |
| `data.voicePreviews[].kind` | clone または design。 |
| `data.voicePreviews[].name` | プレビューの表示名。デザインされた候補では、指定名の末尾に番号が追加されます。 |
| `data.voicePreviews[].previewUrl` | 再生可能な一時音声 URL。プレビューが有効な間は、voices\_preview\_get で新しい URL を取得できます。 |
| `data.voicePreviews[].expiresAt` | プレビューの有効期限を表す Unix タイムスタンプ（ミリ秒）。 |
| `data.voicePreviews[].durationSeconds` | プレビュー音声の長さ。秒単位。 |
| `data.creationUsage.cloneTrial` | limit、used、remaining を含む、生涯を通じたクローンプレビューのお試し利用枠。 |
| `data.creationUsage.design` | 1 日あたりの音声デザイン利用枠。limit、used、remaining と、Unix 時間のミリ秒単位の resetsAt を含みます。 |
| `data.creationUsage.previewExpiresAfterHours` | 未保存プレビューの有効期間（時間）。現在は24です。 |
## リクエストの復旧とポーリング
接続が切断された後も同じ識別子を使用してください。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":"284a861a-4da8-4d67-ad48-8123e76c8e91","operation":"voices_preview_clone"}'
```
```json HTTP 200 theme={null}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"operation": "voices_preview_clone",
"status": "completed",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"resultStored": true,
"result": {
"voicePreviews": [
{
"id": "44444444-4444-4444-8444-444444444444",
"kind": "clone",
"name": "Studio narrator",
"previewUrl": "https://files.example.com/narrator-preview.mp3",
"expiresAt": 1792238400000,
"durationSeconds": 10
}
],
"creationUsage": {
"cloneTrial": {
"limit": 1,
"used": 1,
"remaining": 0
},
"design": {
"limit": 5,
"used": 0,
"remaining": 5,
"resetsAt": 1792195200000
},
"previewExpiresAfterHours": 24
}
}
}
}
```
## 操作の注意事項
* この変更操作には UUID v4 requestId を使用し、再試行時も同じ引数で再利用してください。長時間実行アクションは最初に running のリクエストを返します。この例は、action\_request\_get で取得できる完了済みハンドラー結果です。
* 所有する音声サンプル 1–3 個をアップロードし、完了済みの fileKey を使用してください。対応形式は MP3、WAV、M4A、OGG、Opus です。各ファイルは空でなく、最大 20 MiB（20,971,520 バイト）である必要があります。リモート URL や他のアカウントのアップロードは拒否されます。
* 読み取り可能な音声サンプルの合計時間は 10 秒以上、120 秒以下である必要があります。trimToMaxDuration のデフォルトは false です。合計が 120 秒を超えるサンプルを比例配分でトリミングするには、true に設定してください。
* hasPermission は JSON のブール値 true で、すべてのサンプルに対する権限を確認する必要があります。"true" などの文字列値は拒否されます。
* name は前後の空白を除去した後で 1–80 文字である必要があります。省略可能な language には、任意のサブタグを含む 2–3 文字の言語コードを、最大 35 文字で指定できます。
* アカウントにつき全期間で 1 回限りのクローンプレビュー体験を使用します。このプレビューを作成しても、再利用可能な TTS 音声は保存されず、保存音声スロットも使用しません。
* 新しいクローン候補は kind: clone で、有効期間は 24 時間です。再生は約 10 秒に制限されます。
* レスポンスには、有効な未保存プレビューがすべて含まれます。voices\_preview\_get で再生 URL を更新し、有料プランでは voices\_save\_preview で選択した候補を保存してください。
* language は、対応するスクリプトがある場合にプレビュー用スクリプトを選択します。アップロードしたサンプルの翻訳をリクエストするものではありません。
* 読み上げ履歴とカスタム音声は認証済みアカウントに属します。チームの請求設定によって、他のメンバーの読み上げや音声へのアクセス権が付与されることはありません。
## 使用量
正常に実行された呼び出しごとに、月間 API/MCP 呼び出し回数を 1 回消費します。メディアクレジットと、その操作固有の生成枠も適用されます。
## エラー
| HTTP ステータス | コード | 意味または対処方法 |
| - | - | - |
| 400 | `CREDENTIAL_IN_QUERY` | access\_token または api\_key クエリパラメーターに認証情報が指定されています。認証情報はヘッダーで送信してください。 |
| 400 | `IDEMPOTENCY_CONFLICT` | Idempotency-Key ヘッダーとリクエストボディの requestId は一致させる必要があります。 |
| 400 | `INVALID_REQUEST_ID` | UUID v4 の requestId または Idempotency-Key を指定してください。 |
| 400 | `VALIDATION_ERROR` | 入力がアクションスキーマと一致しません。フィールドエラーは details を確認してください。 |
| 400 | `VOICE_CLONE_INVALID_AUDIO` | アップロードしたサンプルから、0より大きい音声の長さを読み取れません。 |
| 400 | `VOICE_CLONE_INVALID_FILE_SIZE` | 保存済みサンプルが空、または 20 MiB を超えています。 |
| 400 | `VOICE_CLONE_INVALID_FILE_TYPE` | サンプルが MP3、WAV、M4A、OGG、Opus の音声ではありません。 |
| 400 | `VOICE_CLONE_SAMPLE_TOO_LONG` | サンプルの合計が120秒を超えており、トリミングが有効になっていません。 |
| 400 | `VOICE_CLONE_SAMPLE_TOO_SHORT` | サンプルの音声が合計10秒未満です。 |
| 400 | `VOICE_SAMPLE_NOT_OWNED` | サンプルキーが安全でないか、認証済みアカウントに属していません。 |
| 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` | 実効的なチームオーナーのアカウントが見つかりませんでした。 |
| 404 | `USER_NOT_FOUND` | 認証済みアカウントはすでに存在しません。 |
| 404 | `VOICE_PREVIEW_NOT_FOUND` | このリクエストは別のアカウントに属します。 |
| 409 | `CONCURRENT_ACTION_LIMIT_REACHED` | このアカウントでは、すでに 10 件の連携アクションが実行中です。新しいアクションを開始する前に、既存のリクエストをポーリングしてください。 |
| 409 | `IDEMPOTENCY_CONFLICT` | 識別子を再利用する場合は、同じ操作と引数でのみ使用してください。 |
| 409 | `VOICE_CREATION_IN_PROGRESS` | プレビューがまだ作成中か、アカウント削除により新たな音声操作がブロックされています。 |
| 409 | `VOICE_CREATION_REQUEST_MISMATCH` | この requestId は、異なる音声の種類、設定、またはサンプルに使用されています。 |
| 409 | `VOICE_TRIAL_LIMIT_REACHED` | このアカウントは、生涯で1回限りのクローンプレビューお試し枠をすでに使用しています。 |
| 410 | `VOICE_PREVIEW_EXPIRED` | リクエストの音声プレビューは期限切れか、すでに利用できません。 |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | 月次リセットを待つか、プランを変更してください。 |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Retry-After がある場合は指定時間を待ち、バックオフを使用してください。 |
| 500 | `INTERNAL_ERROR` | 変更操作を再試行するか判断する前に、保存済みリクエストの状態とリソースの履歴を確認してください。 |
| 502 | `INTERNAL_ERROR` | アクションを完了できないか、結果を確認できませんでした。別の生成を開始する前に、リクエストの状態とリソースの履歴を確認してください。 |
| 503 | `ACTION_RESULT_UNAVAILABLE` | アクションは実行されましたが、結果を保存できませんでした。新しい生成を開始する前に、保存済みリクエストの状態とリソース履歴を確認してください。 |
| 503 | `SERVER_RESTARTING` | サーバーが再起動中です。少し待ってから再試行し、変更操作では同じリクエスト識別子を使用してください。 |
```json theme={null}
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["voices:write"]
}
}
```
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.