> ## 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.
# 音声と音声プレビューを一覧表示
> 利用可能な読み上げ音声、保存済みのカスタム音声、再生可能な有効期限内のプレビュー、音声作成の利用枠を一覧表示します。
利用可能な読み上げ音声、保存済みのカスタム音声、再生可能な有効期限内のプレビュー、音声作成の利用枠を一覧表示します。
```http theme={null}
POST https://api.voicecheap.ai/v1/actions/voices_list
```
## 認証と権限
このヘッダーに VoiceCheap API キーを指定してください。同じ API キーを Authorization: Bearer で送信することもできます。OAuth アクセストークンは MCP
でのみ使用でき、この REST エンドポイントでは使用できません。
必要な権限: `voices:read`.
有効な有料サブスクリプションが必要です。権限によってチーム内のロール、リソースの所有権、メディアクレジット、プランの制限が変わることはありません。
## パラメーター
空の JSON オブジェクトを送信してください。このアクションに入力フィールドはありません。
以下の JSON Schema は、ディスカバリーで公開される正確なフィールド名、ネストされた型、デフォルト値、範囲、許容値を保持しています。フィールド間の追加ルールは操作の注意事項に記載されています。
```json theme={null}
{
"type": "object",
"properties": {},
"additionalProperties": false
}
```
## リクエスト例
例に記載されたリソース識別子とメディアキーを、ご自身のアカウントで返された値に置き換えてください。同じ変更操作を再試行する場合は、リクエスト識別子を変更しないでください。
```bash cURL theme={null}
curl --request POST 'https://api.voicecheap.ai/v1/actions/voices_list' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{}'
```
```javascript JavaScript theme={null}
const input = {};
const response = await fetch('https://api.voicecheap.ai/v1/actions/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);
```
```python Python theme={null}
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/voices_list",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
```
## レスポンス
初回実行が成功すると、操作結果を data に格納して HTTP 200 を返します。同じリクエストを再送した場合は、代わりに保存済みリクエストの状態を返すことがあります。例はサポートされるレスポンスの一例であり、すべての任意フィールドを示すものではありません。
利用可能な TTS カタログ音声と所有する保存済みカスタム音声、保存スロットの利用枠、有効な未保存プレビュー、音声作成の利用枠。
```json HTTP 200 theme={null}
{
"data": {
"voices": [
{
"accent": "original",
"id": "clone:33333333-3333-4333-8333-333333333333",
"name": "Studio narrator",
"previewUrl": "https://files.example.com/saved-narrator.mp3",
"source": "clone"
},
{
"id": "933563129e564b19a115bedd57b7406a",
"name": "Sarah",
"accent": "english",
"gender": "female",
"style": "conversational",
"previewFileName": "sarah-en.mp3",
"source": "catalog"
}
],
"cloneUsage": {
"canClone": true,
"limit": 10,
"remaining": 9,
"used": 1
},
"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
}
}
}
```
## 結果フィールド
| フィールド | 説明 |
| - | - |
| `data.voices` | 所有する保存済み TTS ボイスに続けて、利用可能なカタログボイスを並べます。 |
| `data.voices[].id` | tts\_generate 用の TTS 選択 ID。カスタム値は clone:\ を使用します。 |
| `data.voices[].name` | 音声の表示名。 |
| `data.voices[].source` | catalog または clone。 |
| `data.voices[].accent` | 音声のアクセント。カスタムボイスでは original。 |
| `data.voices[].gender` | 任意のカタログ音声の性別。 |
| `data.voices[].style` | 任意のカタログ音声の話し方。 |
| `data.voices[].previewFileName` | 任意の同梱カタログプレビューのファイル名。ダウンロードURLではありません。 |
| `data.voices[].previewUrl` | 省略可能な再生用 URL。カスタム音声の URL は一時的なものです。 |
| `data.cloneUsage.canClone` | 現在のプランでカスタム TTS 音声の保存が許可されているか。空きスロット数は remaining で確認してください。 |
| `data.cloneUsage.limit` | 保存できるカスタム TTS 音声スロット数のプラン上限。 |
| `data.cloneUsage.used` | 作成予約分を含む、使用中の TTS 音声スロット数。 |
| `data.cloneUsage.remaining` | 利用可能な TTS ボイス保存枠。 |
| `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です。 |
## 操作の注意事項
* カタログの例は省略されています。アクションは利用可能な TTS ライブラリを返し、カタログ項目の前に保存済みカスタムボイスを並べます。
* tts\_generate では voices\[].id を使用してください。保存済み音声は clone:\ を使用し、カタログ ID は不透明です。これらの ID は dubbing\_voices\_list とは別系統です。
* カタログ項目には accent、gender、style、previewFileName が含まれ、previewUrl は省略可能です。保存済みカスタム項目には accent: original、source: clone、一時的な previewUrl が含まれます。
* canClone はプランがカスタム TTS 音声の保存に対応しているか、remaining は空きスロット数を示します。予約済みの作成が used に計上される場合があります。
* voicePreviews に含まれるのは、所有する未保存の ready 状態で、有効期限内の候補のみです。プレビューの有効期間は24時間ですが、再生用URLはそれより早く期限切れになる場合があります。
* cloneTrial は、生涯で1回のクローンプレビュー利用枠です。有料プランではUTC日ごとに5回のデザインリクエストが可能で、成功するたびに2つの候補を作成します。creationUsage は現在の利用枠とリセット時刻を示します。
* 読み上げ履歴とカスタム音声は認証済みアカウントに属します。チームの請求設定によって、他のメンバーの読み上げや音声へのアクセス権が付与されることはありません。
## 使用量
正常に実行された呼び出しごとに、月間 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` | 認証済みアカウントはすでに存在しません。 |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | 月次リセットを待つか、プランを変更してください。 |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Retry-After がある場合は指定時間を待ち、バックオフを使用してください。 |
| 500 | `INTERNAL_ERROR` | 変更操作を再試行するか判断する前に、保存済みリクエストの状態とリソースの履歴を確認してください。 |
| 503 | `SERVER_RESTARTING` | サーバーが再起動中です。少し待ってから再試行し、変更操作では同じリクエスト識別子を使用してください。 |
```json theme={null}
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["voices:read"]
}
}
```
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.