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

# List generated speech

> List your speech history, newest first. Pass nextCursor as cursor to retrieve older creations.

List your speech history, newest first. Pass nextCursor as cursor to retrieve older creations.

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

## Authentication and permissions

<ParamField header="x-api-key" type="string" required>
  Send a VoiceCheap API key in this header. Authorization: Bearer with the same API key is also supported. OAuth access tokens are accepted only by
  MCP, not by this REST endpoint.
</ParamField>

Required permissions: `tts:read`.

An active paid subscription is required. Permissions do not change team roles, resource ownership, media credits, or plan limits.

## Parameters

<ParamField body="limit" type="integer">
  Integer value.

  Minimum: 1. Maximum: 100. Default: 30.
</ParamField>

<ParamField body="cursor" type="string">
  History ID returned by tts\_generate or tts\_list.

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

<Accordion title="Complete input schema">
  The JSON Schema below preserves the exact field names, nested types, defaults, bounds, and accepted values exposed by discovery. Additional cross-field rules are listed in the operation notes.

  ```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>

## Request examples

Replace example resource identifiers and media keys with values returned for your account. Keep the request identifier stable when retrying the same mutation.

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

## Response

A successful first execution returns HTTP 200 with the operation result under data. A replay may return saved request state instead. The example shows one supported response, not every optional field.

Newest-first page of speech history summaries and the cursor to request older creations.

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

## Result fields

| Field | Description |
| - | - |
| `data.items` | Speech history summaries, newest first. |
| `data.items[].historyId` | Owned speech history ID: 64 lowercase hexadecimal characters, optionally prefixed with free- for an app preview. |
| `data.items[].voice` | The original TTS selection ID, including clone:\<UUID> for a saved custom voice. |
| `data.items[].voiceName` | Optional saved display name of the selected voice. |
| `data.items[].voiceSource` | Optional voice source: catalog or clone. |
| `data.items[].inputType` | Original input type: text or pdf. |
| `data.items[].instructionPreset` | Stored delivery preset. |
| `data.items[].sourceFileName` | Optional original filename supplied at generation. |
| `data.items[].characterCount` | Character count recorded for this speech creation. |
| `data.items[].durationSeconds` | Audio duration in seconds. |
| `data.items[].createdAt` | Creation time as a Unix timestamp in milliseconds. |
| `data.items[].updatedAt` | Last update time as a Unix timestamp in milliseconds. |
| `data.items[].status` | Stored successful speech items use success; tts\_generate uses completed in its generation result. |
| `data.items[].textPreview` | First 180 characters of the stored script. |
| `data.items[].isPreview` | true while the audio contains only a preview of the stored script. |
| `data.nextCursor` | Last item’s historyId for a full page, otherwise null. |

## Operation notes

* limit defaults to 30 and ranges from 1 to 100. Pass the returned nextCursor as cursor for the following page.
* nextCursor is null when fewer than limit items are returned. A full final page can still return a cursor; the next call may be empty.
* Each textPreview contains at most the first 180 characters. Use tts\_get for the complete script and audio URL.
* History items report status: success. This differs from status: completed in a speech generation result.
* Speech history and custom voices belong to the authenticated account. Team billing does not grant access to another member’s speech or voices.

## Usage

Each successful invocation consumes one monthly API/MCP call. Media credits and the operation's own generation allowances also apply.

## Errors

| HTTP status | Code | Meaning or recovery |
| - | - | - |
| 400 | `CREDENTIAL_IN_QUERY` | Credentials were supplied in an access\_token or api\_key query parameter. Send credentials in headers. |
| 400 | `VALIDATION_ERROR` | The input does not match the action schema; inspect details for field errors. |
| 401 | `API_KEY_EXPIRED` | The API key has expired. |
| 401 | `INVALID_API_KEY` | Provide a valid, unexpired API key. |
| 401 | `INVALID_CREDENTIAL` | The Authorization header is malformed or conflicts with x-api-key. |
| 401 | `MISSING_CREDENTIAL` | No usable header credential was supplied, or it exceeded 4096 characters. |
| 401 | `USER_NOT_FOUND` | The credential's account no longer exists. |
| 403 | `AMBIGUOUS_TEAM_API_KEY` | The credential's user belongs to more than one team, so the billing context is ambiguous. |
| 403 | `INSUFFICIENT_SCOPE` | Grant every required permission or choose another credential. |
| 403 | `INTEGRATION_PLAN_UNSUPPORTED` | The account's integration limits could not be verified. |
| 403 | `SUBSCRIPTION_REQUIRED` | Use an active paid subscription. |
| 403 | `TEAM_OWNER_NOT_FOUND` | The effective team owner account could not be found. |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | Wait for the monthly reset or change plan. |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Wait for Retry-After when present and use backoff. |
| 500 | `INTERNAL_ERROR` | Check saved request state and resource history before deciding to retry a mutation. |
| 503 | `SERVER_RESTARTING` | The server is restarting. Retry shortly and keep the same request identifier for a mutation. |

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