curl --request POST 'https://api.voicecheap.ai/v1/actions/dubbing_voices_list' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"locale":"en","language":"en","search":"Studio narrator"}'
const input = {
locale: 'en',
language: 'en',
search: 'Studio narrator',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/dubbing_voices_list', {
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/dubbing_voices_list",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"locale": "en", "language": "en", "search": "Studio narrator"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"voices": [
{
"id": "dubbing_voice_R8q3k9Yp",
"name": "Studio narrator",
"source": "custom",
"previewUrl": "https://files.example.com/dubbing-narrator.mp3"
}
],
"cloneUsage": {
"limit": 7,
"used": 1,
"remaining": 6
}
}
}
吹き替え音声
吹き替え音声を一覧表示
アプリと同じ吹き替え音声カタログ、および保存済みのカスタム吹き替え音声を参照します。再生可能な音声例と音声スロットの利用枠も含まれます。これらの ID は動画吹き替え用です。テキスト読み上げ専用のライブラリは voices_list で取得できます。
POST
/
v1
/
actions
/
dubbing_voices_list
curl --request POST 'https://api.voicecheap.ai/v1/actions/dubbing_voices_list' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"locale":"en","language":"en","search":"Studio narrator"}'
const input = {
locale: 'en',
language: 'en',
search: 'Studio narrator',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/dubbing_voices_list', {
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/dubbing_voices_list",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"locale": "en", "language": "en", "search": "Studio narrator"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"voices": [
{
"id": "dubbing_voice_R8q3k9Yp",
"name": "Studio narrator",
"source": "custom",
"previewUrl": "https://files.example.com/dubbing-narrator.mp3"
}
],
"cloneUsage": {
"limit": 7,
"used": 1,
"remaining": 6
}
}
}
アプリと同じ吹き替え音声カタログ、および保存済みのカスタム吹き替え音声を参照します。再生可能な音声例と音声スロットの利用枠も含まれます。これらの ID は動画吹き替え用です。テキスト読み上げ専用のライブラリは voices_list で取得できます。
必要な権限:
POST https://api.voicecheap.ai/v1/actions/dubbing_voices_list
認証と権限
string
必須
このヘッダーに VoiceCheap API キーを指定してください。同じ API キーを Authorization: Bearer で送信することもできます。OAuth アクセストークンは MCP
でのみ使用でき、この REST エンドポイントでは使用できません。
voices:read.
有効な有料サブスクリプションが必要です。権限によってチーム内のロール、リソースの所有権、メディアクレジット、プランの制限が変わることはありません。
パラメーター
string
テキスト値。許容値: “en”, “fr”, “es”, “de”, “it”, “pt”, “pl”, “zh”, “ja”. デフォルト値: “en”.
string
テキスト値。最小文字数: 2. 最大文字数: 35.
string
テキスト値。最大文字数: 100.
完全な入力スキーマ
完全な入力スキーマ
以下の JSON Schema は、ディスカバリーで公開される正確なフィールド名、ネストされた型、デフォルト値、範囲、許容値を保持しています。フィールド間の追加ルールは操作の注意事項に記載されています。
{
"type": "object",
"properties": {
"locale": {
"default": "en",
"type": "string",
"enum": ["en", "fr", "es", "de", "it", "pt", "pl", "zh", "ja"]
},
"language": {
"type": "string",
"minLength": 2,
"maxLength": 35
},
"search": {
"type": "string",
"maxLength": 100
}
},
"additionalProperties": false
}
リクエスト例
例に記載されたリソース識別子とメディアキーを、ご自身のアカウントで返された値に置き換えてください。同じ変更操作を再試行する場合は、リクエスト識別子を変更しないでください。curl --request POST 'https://api.voicecheap.ai/v1/actions/dubbing_voices_list' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"locale":"en","language":"en","search":"Studio narrator"}'
const input = {
locale: 'en',
language: 'en',
search: 'Studio narrator',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/dubbing_voices_list', {
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/dubbing_voices_list",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"locale": "en", "language": "en", "search": "Studio narrator"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
レスポンス
初回実行が成功すると、操作結果を data に格納して HTTP 200 を返します。同じリクエストを再送した場合は、代わりに保存済みリクエストの状態を返すことがあります。例はサポートされるレスポンスの一例であり、すべての任意フィールドを示すものではありません。 条件に一致するカタログの動画吹き替え音声と所有するカスタム音声、および現在の吹き替え音声保存枠。{
"data": {
"voices": [
{
"id": "dubbing_voice_R8q3k9Yp",
"name": "Studio narrator",
"source": "custom",
"previewUrl": "https://files.example.com/dubbing-narrator.mp3"
}
],
"cloneUsage": {
"limit": 7,
"used": 1,
"remaining": 6
}
}
}
結果フィールド
| フィールド | 説明 |
|---|---|
data.voices | 条件に一致する所有済みのカスタム吹き替え音声に続いて、カタログの吹き替え音声が返されます。 |
data.voices[].id | 不透明な吹き替え音声 ID。tts_generate ではなく、吹き替え操作に使用してください。 |
data.voices[].name | ローカライズされたメタデータがある場合、指定ロケールでの音声表示名。 |
data.voices[].source | 所有する保存済み吹き替えボイスでは custom、カタログボイスでは catalog。 |
data.voices[].previewUrl | 任意の再生可能なサンプルの絶対 URL。 |
data.voices[].language | 任意のカタログ言語コード。カスタムボイスでは通常、言語メタデータは省略されます。 |
data.voices[].languages | 任意のカタログ言語コード一覧。 |
data.voices[].accent | 任意のローカライズ済みカタログアクセント。 |
data.voices[].description | 任意のローカライズされたカタログ説明。 |
data.voices[].age | 任意のローカライズ済みカタログ年齢説明。 |
data.voices[].gender | 任意のローカライズされたカタログの性別説明。 |
data.voices[].useCase | 任意のローカライズされたカタログ用途。 |
data.voices[].category | 任意のローカライズされたカタログカテゴリー。 |
data.cloneUsage.limit | 現在のプランの、保存済みカスタム吹き替え音声スロットの上限。 |
data.cloneUsage.used | 保存済みカスタム吹き替え音声の数。 |
data.cloneUsage.remaining | 保存済みカスタム吹き替え音声の未使用スロット数。 |
操作の注意事項
- これは動画吹き替え用のライブラリです。別系統の TTS カタログと clone:<UUID> の選択には voices_list を使用してください。
- locale のデフォルトは en で、en、fr、es、de、it、pt、pl、zh、ja を指定できます。ローカライズされたテキストがない場合は、英語または利用可能な別の翻訳が使用されます。
- 任意の search は、音声名とローカライズされた説明を対象に、大文字と小文字を区別せず部分一致で検索します。前後の空白を除いて最大100文字です。
- 省略可能な language は 2–35 文字で、カタログの language または languages メタデータと完全一致で照合されます。カスタム音声を含め、言語メタデータのない音声も引き続き含まれます。
- 一覧はページ分割されません。カタログボイスとカスタムボイスでは、任意のメタデータが異なります。クローン保存枠の使用数には、保存済みカスタム吹き替えボイスだけを数えます。
- この例では、所有するカスタム音声1件に絞り込みます。一覧のフィールド名は previewUrl です。クローン作成では、同じ音声サンプルが audioExampleUrl で返されます。
- 読み上げ履歴とカスタム音声は認証済みアカウントに属します。チームの請求設定によって、他のメンバーの読み上げや音声へのアクセス権が付与されることはありません。
使用量
正常に実行された呼び出しごとに、月間 API/MCP 呼び出し回数を 1 回消費します。メディアクレジットと、その操作固有の生成枠も適用されます。エラー
| HTTP ステータス | コード | 意味または対処方法 |
|---|---|---|
| 400 | CREDENTIAL_IN_QUERY | access_token または api_key クエリパラメーターに認証情報が指定されています。認証情報はヘッダーで送信してください。 |
| 400 | VALIDATION_ERROR | 入力がアクションスキーマと一致しません。フィールドエラーは details を確認してください。 |
| 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 | AMBIGUOUS_TEAM_API_KEY | 認証情報のユーザーが複数のチームに属しているため、課金コンテキストが曖昧です。 |
| 403 | INSUFFICIENT_SCOPE | 必要な権限をすべて付与するか、別の認証情報を使用してください。 |
| 403 | INTEGRATION_PLAN_UNSUPPORTED | アカウントの連携上限を確認できませんでした。 |
| 403 | SUBSCRIPTION_REQUIRED | 有効な有料サブスクリプションを使用してください。 |
| 403 | TEAM_OWNER_NOT_FOUND | 実効的なチームオーナーのアカウントが見つかりませんでした。 |
| 429 | INTEGRATION_MONTHLY_LIMIT_REACHED | 月次リセットを待つか、プランを変更してください。 |
| 429 | INTEGRATION_RATE_LIMIT_REACHED | Retry-After がある場合は指定時間を待ち、バックオフを使用してください。 |
| 500 | INTERNAL_ERROR | 変更操作を再試行するか判断する前に、保存済みリクエストの状態とリソースの履歴を確認してください。 |
| 503 | SERVER_RESTARTING | サーバーが再起動中です。少し待ってから再試行し、変更操作では同じリクエスト識別子を使用してください。 |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["voices:read"]
}
}
このページは役に立ちましたか?

