> ## 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.

# 吹き替え音声をクローン

> 明示的な許可を得た、ご自身が所有するアップロード済み音声サンプルから、保存可能なカスタム動画吹き替え音声を作成します。アプリのカスタム音声スロット上限が適用され、音声例も含まれます。重複作成を避けるため requestId を再利用してください。

明示的な許可を得た、ご自身が所有するアップロード済み音声サンプルから、保存可能なカスタム動画吹き替え音声を作成します。アプリのカスタム音声スロット上限が適用され、音声例も含まれます。重複作成を避けるため requestId を再利用してください。

```http theme={null}
POST https://api.voicecheap.ai/v1/actions/dubbing_voices_clone
```

## 認証と権限

<ParamField header="x-api-key" type="string" required>
  このヘッダーに VoiceCheap API キーを指定してください。同じ API キーを Authorization: Bearer で送信することもできます。OAuth アクセストークンは MCP
  でのみ使用でき、この REST エンドポイントでは使用できません。
</ParamField>

必要な権限: `voices:write`.

有効な有料サブスクリプションが必要です。権限によってチーム内のロール、リソースの所有権、メディアクレジット、プランの制限が変わることはありません。

## パラメーター

<ParamField body="requestId" type="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}$`.
</ParamField>

<ParamField body="name" type="string" required>
  テキスト値。

  最小文字数: 1. 最大文字数: 80.
</ParamField>

<ParamField body="fileKey" type="string" required>
  テキスト値。

  最小文字数: 1. 最大文字数: 1024.
</ParamField>

<ParamField body="hasPermission" type="boolean" required>
  真偽値。

  必須の値: true.
</ParamField>

<Accordion title="完全な入力スキーマ">
  以下の JSON Schema は、ディスカバリーで公開される正確なフィールド名、ネストされた型、デフォルト値、範囲、許容値を保持しています。フィールド間の追加ルールは操作の注意事項に記載されています。

  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "requestId": {
        "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}$",
        "description": "UUID v4 for this action. Reuse the same ID with identical arguments on retries."
      },
      "name": {
        "type": "string",
        "minLength": 1,
        "maxLength": 80
      },
      "fileKey": {
        "type": "string",
        "minLength": 1,
        "maxLength": 1024
      },
      "hasPermission": {
        "type": "boolean",
        "const": true
      }
    },
    "required": ["name", "fileKey", "hasPermission"],
    "additionalProperties": false
  }
  ```
</Accordion>

## 冪等性

変更操作ごとに、requestId または Idempotency-Key HTTP ヘッダーに UUID v4 を指定してください。ネットワーク障害後の再試行では、同じ識別子と同一の引数を使用します。両方を指定する場合は一致させる必要があります。保存済みリクエストを再取得しても、操作は再実行されず、月間呼び出し回数も追加で消費されません。失敗または中断したリクエストは自動的には再開されません。

すべての変更操作は、再試行時に同じリクエストがまだ実行中であれば、通常の初回実行が同期処理であっても HTTP 202 を返す場合があります。実行が完了していても resultStored が false の場合、再試行では元の結果ではなく、保存済みリクエストの状態を HTTP 200 で返します。出力は対応するドメインの履歴、結果、またはダウンロードアクションで取得してください。

## リクエスト例

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

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST 'https://api.voicecheap.ai/v1/actions/dubbing_voices_clone' \
    --header "x-api-key: $VOICECHEAP_API_KEY" \
    --header 'Content-Type: application/json' \
    --data '{"requestId":"284a861a-4da8-4d67-ad48-8123e76c8e91","name":"Studio narrator","fileKey":"uploads/example-user/66666666-6666-4666-8666-666666666666-narrator.wav","hasPermission":true}'
  ```

  ```javascript JavaScript theme={null}
  const input = {
    requestId: '284a861a-4da8-4d67-ad48-8123e76c8e91',
    name: 'Studio narrator',
    fileKey: 'uploads/example-user/66666666-6666-4666-8666-666666666666-narrator.wav',
    hasPermission: true,
  };
  const response = await fetch('https://api.voicecheap.ai/v1/actions/dubbing_voices_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/dubbing_voices_clone",
      headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
      json={"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "name": "Studio narrator", "fileKey": "uploads/example-user/66666666-6666-4666-8666-666666666666-narrator.wav", "hasPermission": True},
      timeout=120,
  )
  body = response.json()
  if not response.ok:
      raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
  print(body)
  ```
</RequestExample>

## レスポンス

この操作は実行中に HTTP 202 を返します。requestId を保存し、その識別子と元の操作名を指定して action\_request\_get をポーリングしてください。ポーリングの状態は running、completed、failed、interrupted です。完了した結果が別のメディアジョブを示す場合は、その操作に対応するステータスまたは出力取得アクションで処理を続けてください。

保存済みカスタム吹き替え音声。ID、名前、任意の音声サンプルを含みます。TTS形式の voice または cloneUsage エンベロープはありません。

<ResponseExample>
  ```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": {
      "id": "dubbing_voice_R8q3k9Yp",
      "name": "Studio narrator",
      "audioExampleUrl": "https://files.example.com/dubbing-narrator.mp3"
    },
    "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
  }
  ```

  ```json HTTP 202 replay_running theme={null}
  {
    "data": {
      "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
      "operation": "dubbing_voices_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": "dubbing_voices_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"
  }
  ```
</ResponseExample>

## 結果フィールド

| フィールド | 説明 |
| - | - |
| `data.id` | 保存済み吹き替え音声の不透明なID。 |
| `data.name` | 保存済み音声の表示名。 |
| `data.audioExampleUrl` | 省略可能な再生用サンプル音声 URL。一覧取得と詳細取得のレスポンスでは previewUrl として返されます。 |

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

接続が切断された後も同じ識別子を使用してください。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":"dubbing_voices_clone"}'
```

```json HTTP 200 theme={null}
{
  "data": {
    "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
    "operation": "dubbing_voices_clone",
    "status": "completed",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "resultStored": true,
    "result": {
      "id": "dubbing_voice_R8q3k9Yp",
      "name": "Studio narrator",
      "audioExampleUrl": "https://files.example.com/dubbing-narrator.mp3"
    }
  }
}
```

## 操作の注意事項

* この変更操作には UUID v4 requestId を使用し、再試行時も同じ引数で再利用してください。長時間実行アクションは最初に running のリクエストを返します。この例は、action\_request\_get で取得できる完了済みハンドラー結果です。
* このアクションは、所有する completed の音声アップロードを1つ受け付け、JSON のブール値として hasPermission: true を要求します。リモート URL や別アカウントの fileKey は受け付けません。
* 対応するサンプル拡張子は AAC、AC3、EAC3、FLAC、M4A、X-M4A、MP2、MP3、OGG、WAV です。ファイルは空でなく、読み取り可能な音声で、プランのアップロード上限内かつ最大 250,000,000 バイト（250 MB）である必要があります。
* 専用の voices*upload*\* アクション群は制限が厳しく、MP3、WAV、M4A、OGG、Opus のみで、アップロードごとに最大 20 MiB です。このアップロード群で受け付けられたファイルも、この吹き替えアクションの対応サンプル形式に一致する必要があります。ここでは Opus に対応していません。
* name は前後の空白除去後 1–80 文字で、制御文字を含めることはできません。
* TTS音声クローンに適用されるサンプル合計10–120秒のルールは、このアクションには適用されません。サンプルは正の長さを読み取ることができ、45分を超えない必要があります。音声はこの上限に合わせて自動トリミングされません。
* アカウントの保存済みカスタム吹き替え音声のスロット利用枠を使用します。更新後の cloneUsage は dubbing\_voices\_list で取得してください。クローンの結果自体には含まれません。
* 吹き替えには、返された不透明な id を使用してください。clone: プレフィックスは付かず、TTS音声の選択には使用できません。
* 読み上げ履歴とカスタム音声は認証済みアカウントに属します。チームの請求設定によって、他のメンバーの読み上げや音声へのアクセス権が付与されることはありません。

## 使用量

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

## エラー

| HTTP ステータス | コード | 意味または対処方法 |
| - | - | - |
| 400 | `BAD_REQUEST` | サンプルの正の長さを読み取れないか、吹き替え用クローンの長さの上限 45 分を超えているか、長すぎるため拒否されました。 |
| 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_NAME_INVALID` | 名前が空、長すぎる、または制御文字を含んでいます。 |
| 400 | `VOICE_SAMPLE_INVALID_SIZE` | サンプルが空、実際のバイト数が申告サイズと不一致、または現在のプラン上限もしくは 250 MB を超えています。 |
| 400 | `VOICE_SAMPLE_INVALID_TYPE` | サンプルのファイル名が、対応する吹き替え音声形式ではありません。 |
| 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` | 実効的なチームオーナーのアカウントが見つかりませんでした。 |
| 409 | `CONCURRENT_ACTION_LIMIT_REACHED` | このアカウントでは、すでに 10 件の連携アクションが実行中です。新しいアクションを開始する前に、既存のリクエストをポーリングしてください。 |
| 409 | `DUBBING_VOICE_LIMIT_REACHED` | カスタム吹き替え音声の保存スロットがすべて使用されています。 |
| 409 | `IDEMPOTENCY_CONFLICT` | この requestId は、異なる吹き替えボイス入力ですでに使用されています。 |
| 409 | `VOICE_MUTATION_IN_PROGRESS` | このアカウントでは、別の吹き替え音声の変更操作が実行中です。 |
| 409 | `VOICE_MUTATION_LEASE_LOST` | 変更処理の実行権が失われました。再試行する前に、リクエストの状態と保存済み音声を確認してください。 |
| 409 | `VOICE_REQUEST_ALREADY_STARTED` | この音声リクエストは以前に開始されていますが、最終結果が確認できていません。別のリクエストを開始する前に、音声の一覧とリクエストの状態を確認してください。 |
| 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.