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

# 生成音声を一覧表示

> 音声履歴を新しい順に一覧表示します。過去の生成音声を取得するには、nextCursor を cursor として指定してください。

音声履歴を新しい順に一覧表示します。過去の生成音声を取得するには、nextCursor を cursor として指定してください。

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

## 認証と権限

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

必要な権限: `tts:read`.

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

## パラメーター

<ParamField body="limit" type="integer">
  整数値。

  最小値: 1. 最大値: 100. デフォルト値: 30.
</ParamField>

<ParamField body="cursor" type="string">
  tts\_generate または tts\_list が返す履歴ID。

  パターン: `^(free-)?[0-9a-f]{64}$`.
</ParamField>

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

  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "limit": {
        "default": 30,
        "type": "integer",
        "minimum": 1,
        "maximum": 100
      },
      "cursor": {
        "type": "string",
        "pattern": "^(free-)?[0-9a-f]{64}$",
        "description": "History ID returned by tts_generate or tts_list."
      }
    },
    "additionalProperties": false
  }
  ```
</Accordion>

## リクエスト例

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

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST 'https://api.voicecheap.ai/v1/actions/tts_list' \
    --header "x-api-key: $VOICECHEAP_API_KEY" \
    --header 'Content-Type: application/json' \
    --data '{"limit":1}'
  ```

  ```javascript JavaScript theme={null}
  const input = {
    limit: 1,
  };
  const response = await fetch('https://api.voicecheap.ai/v1/actions/tts_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/tts_list",
      headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
      json={"limit": 1},
      timeout=120,
  )
  body = response.json()
  if not response.ok:
      raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
  print(body)
  ```
</RequestExample>

## レスポンス

初回実行が成功すると、操作結果を data に格納して HTTP 200 を返します。同じリクエストを再送した場合は、代わりに保存済みリクエストの状態を返すことがあります。例はサポートされるレスポンスの一例であり、すべての任意フィールドを示すものではありません。

音声生成履歴の概要を新しい順に並べたページと、古い生成履歴を取得するためのカーソル。

<ResponseExample>
  ```json HTTP 200 theme={null}
  {
    "data": {
      "items": [
        {
          "historyId": "722c80c6412edd4c3dcd625061e1c1feafbb0d54274d95fd8b5ca047f8cdd23d",
          "textPreview": "Hello world.",
          "voice": "933563129e564b19a115bedd57b7406a",
          "voiceName": "Sarah",
          "voiceSource": "catalog",
          "inputType": "text",
          "instructionPreset": "narrator",
          "sourceFileName": "launch-script.txt",
          "characterCount": 12,
          "durationSeconds": 1.5,
          "isPreview": false,
          "createdAt": 1792152000000,
          "updatedAt": 1792152000000,
          "status": "success"
        }
      ],
      "nextCursor": "722c80c6412edd4c3dcd625061e1c1feafbb0d54274d95fd8b5ca047f8cdd23d"
    }
  }
  ```
</ResponseExample>

## 結果フィールド

| フィールド | 説明 |
| - | - |
| `data.items` | 音声履歴の概要。新しい順。 |
| `data.items[].historyId` | 所有する音声履歴 ID。64文字の小文字16進数で、アプリプレビューには任意で free- 接頭辞が付きます。 |
| `data.items[].voice` | 元の TTS 選択 ID。保存済みカスタムボイスの場合は clone:\<UUID> を含みます。 |
| `data.items[].voiceName` | 選択した音声の、任意の保存済み表示名。 |
| `data.items[].voiceSource` | 任意の音声ソース：catalog または clone。 |
| `data.items[].inputType` | 元の入力タイプ：text または pdf。 |
| `data.items[].instructionPreset` | 保存済みの話し方プリセット。 |
| `data.items[].sourceFileName` | 生成時に指定した任意の元ファイル名。 |
| `data.items[].characterCount` | この音声生成で記録された文字数。 |
| `data.items[].durationSeconds` | 音声の長さ（秒）。 |
| `data.items[].createdAt` | 作成時刻。ミリ秒単位の Unix タイムスタンプ。 |
| `data.items[].updatedAt` | 最終更新時刻。Unix タイムスタンプのミリ秒単位。 |
| `data.items[].status` | 保存済みの正常完了した音声項目は success を使用します。tts\_generate は生成結果で completed を使用します。 |
| `data.items[].textPreview` | 保存済み台本の先頭 180 文字。 |
| `data.items[].isPreview` | 音声が保存済み台本のプレビューのみを含む間は true。 |
| `data.nextCursor` | ページが最大件数に達した場合は最後の項目の historyId、それ以外は null。 |

## 操作の注意事項

* limit のデフォルトは 30 で、範囲は 1～100 です。次のページには、返された nextCursor を cursor として指定してください。
* 返された項目数が limit 未満の場合、nextCursor は null です。最後のページが上限件数に達している場合はカーソルが返されることがあり、次の呼び出しが空になる場合があります。
* 各 textPreview には先頭から最大 180 文字が含まれます。スクリプト全体と音声 URL には tts\_get を使用してください。
* 履歴項目は status: success を返します。音声生成結果の status: completed とは異なります。
* 読み上げ履歴とカスタム音声は認証済みアカウントに属します。チームの請求設定によって、他のメンバーの読み上げや音声へのアクセス権が付与されることはありません。

## 使用量

正常に実行された呼び出しごとに、月間 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` | サーバーが再起動中です。少し待ってから再試行し、変更操作では同じリクエスト識別子を使用してください。 |

```json theme={null}
{
  "code": "INSUFFICIENT_SCOPE",
  "message": "This credential does not permit the requested action.",
  "status": 403,
  "details": {
    "requiredScopes": ["tts:read"]
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.