curl --request POST 'https://api.voicecheap.ai/v1/actions/voices_preview_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"previewId":"44444444-4444-4444-8444-444444444444"}'
const input = {
previewId: '44444444-4444-4444-8444-444444444444',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/voices_preview_get', {
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_preview_get",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"previewId": "44444444-4444-4444-8444-444444444444"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"id": "44444444-4444-4444-8444-444444444444",
"kind": "clone",
"name": "Studio narrator",
"previewUrl": "https://files.example.com/narrator-preview.mp3",
"expiresAt": 1792238400000,
"durationSeconds": 10
}
}
読み上げ音声
音声プレビューを取得
未保存のクローン音声またはデザイン音声プレビューを再生できる一時 URL を取得します。有効期限前に voices_save_preview で保存してください。
POST
/
v1
/
actions
/
voices_preview_get
curl --request POST 'https://api.voicecheap.ai/v1/actions/voices_preview_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"previewId":"44444444-4444-4444-8444-444444444444"}'
const input = {
previewId: '44444444-4444-4444-8444-444444444444',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/voices_preview_get', {
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_preview_get",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"previewId": "44444444-4444-4444-8444-444444444444"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"id": "44444444-4444-4444-8444-444444444444",
"kind": "clone",
"name": "Studio narrator",
"previewUrl": "https://files.example.com/narrator-preview.mp3",
"expiresAt": 1792238400000,
"durationSeconds": 10
}
}
未保存のクローン音声またはデザイン音声プレビューを再生できる一時 URL を取得します。有効期限前に voices_save_preview で保存してください。
必要な権限:
POST https://api.voicecheap.ai/v1/actions/voices_preview_get
認証と権限
string
必須
このヘッダーに VoiceCheap API キーを指定してください。同じ API キーを Authorization: Bearer で送信することもできます。OAuth アクセストークンは MCP
でのみ使用でき、この REST エンドポイントでは使用できません。
voices:read.
有効な有料サブスクリプションが必要です。権限によってチーム内のロール、リソースの所有権、メディアクレジット、プランの制限が変わることはありません。
パラメーター
string
必須
テキスト値。形式: “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": {
"previewId": {
"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": ["previewId"],
"additionalProperties": false
}
リクエスト例
例に記載されたリソース識別子とメディアキーを、ご自身のアカウントで返された値に置き換えてください。同じ変更操作を再試行する場合は、リクエスト識別子を変更しないでください。curl --request POST 'https://api.voicecheap.ai/v1/actions/voices_preview_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"previewId":"44444444-4444-4444-8444-444444444444"}'
const input = {
previewId: '44444444-4444-4444-8444-444444444444',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/voices_preview_get', {
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_preview_get",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"previewId": "44444444-4444-4444-8444-444444444444"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
レスポンス
初回実行が成功すると、操作結果を data に格納して HTTP 200 を返します。同じリクエストを再送した場合は、代わりに保存済みリクエストの状態を返すことがあります。例はサポートされるレスポンスの一例であり、すべての任意フィールドを示すものではありません。 所有する有効な音声プレビュー1件。更新済みの一時再生 URL とその有効期限を含みます。{
"data": {
"id": "44444444-4444-4444-8444-444444444444",
"kind": "clone",
"name": "Studio narrator",
"previewUrl": "https://files.example.com/narrator-preview.mp3",
"expiresAt": 1792238400000,
"durationSeconds": 10
}
}
結果フィールド
| フィールド | 説明 |
|---|---|
data.id | voices_save_preview に指定する候補の UUID。 |
data.kind | clone または design。 |
data.name | 候補の表示名。 |
data.previewUrl | 新しく発行された再生可能な一時音声URL。 |
data.expiresAt | 候補の有効期限。ミリ秒単位の Unix タイムスタンプ。 |
data.durationSeconds | プレビュー音声の長さ。秒単位。 |
操作の注意事項
- previewId は、voices_preview_clone、voices_design、voices_list が voicePreviews 内で返す候補のUUIDです。
- 表示されるのは ready で、未保存かつ有効期限内のプレビューだけです。保存された候補は clone:<previewId> として voices_list に移動します。期限切れ、保存済み、存在しない、または所有していない候補は、ここでは VOICE_PREVIEW_NOT_FOUND を返します。
- URL は一時的なもので、expiresAt より前に失効する場合があります。プレビュー自体が失効する前に、選択した候補を voices_save_preview で保存してください。
- 読み上げ履歴とカスタム音声は認証済みアカウントに属します。チームの請求設定によって、他のメンバーの読み上げや音声へのアクセス権が付与されることはありません。
使用量
正常に実行された呼び出しごとに、月間 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 | 実効的なチームオーナーのアカウントが見つかりませんでした。 |
| 404 | USER_NOT_FOUND | 認証済みアカウントはすでに存在しません。 |
| 404 | VOICE_PREVIEW_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"]
}
}
このページは役に立ちましたか？