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

# Clone and save a voice

> Clone and save a custom voice from 1–3 owned audio uploads. Explicit permission is required. Samples must total 10–120 seconds and each be at most 20 MB. Plan voice limits apply.

Clone and save a custom voice from 1–3 owned audio uploads. Explicit permission is required. Samples must total 10–120 seconds and each be at most 20 MB. Plan voice limits apply.

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

## 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: `voices:write`.

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

## Parameters

<ParamField body="requestId" type="string">
  Optional at the transport boundary: the server injects an identifier before validation when omitted. Supply your own stable UUID v4 to recover safely from a lost response.

  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}$`.
</ParamField>

<ParamField body="name" type="string" required>
  Text value.

  Minimum length: 1. Maximum length: 80.
</ParamField>

<ParamField body="samples" type="array" required>
  List of values. See the complete input schema for its item structure.

  Minimum items: 1. Maximum items: 3.
</ParamField>

<ParamField body="hasPermission" type="boolean" required>
  Confirm that you have permission to clone the person whose voice is in every sample.

  Required value: true.
</ParamField>

<ParamField body="trimToMaxDuration" type="boolean">
  Boolean value.

  Default: false.
</ParamField>

<ParamField body="language" type="string">
  Text value.

  Maximum length: 35. Pattern: `^[a-z]{2,3}(-[A-Za-z0-9]{2,8})*$`.
</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": {
      "requestId": {
        "description": "UUID v4 for this action. Reuse the same ID with identical arguments on retries.",
        "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}$"
      },
      "name": {
        "type": "string",
        "minLength": 1,
        "maxLength": 80
      },
      "samples": {
        "minItems": 1,
        "maxItems": 3,
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "fileKey": {
              "type": "string",
              "minLength": 1,
              "maxLength": 1024,
              "description": "An uploaded audio fileKey returned by voices_upload_complete for this account."
            }
          },
          "required": ["fileKey"],
          "additionalProperties": false
        }
      },
      "hasPermission": {
        "type": "boolean",
        "const": true,
        "description": "Confirm that you have permission to clone the person whose voice is in every sample."
      },
      "trimToMaxDuration": {
        "default": false,
        "type": "boolean"
      },
      "language": {
        "type": "string",
        "maxLength": 35,
        "pattern": "^[a-z]{2,3}(-[A-Za-z0-9]{2,8})*$"
      }
    },
    "required": ["name", "samples", "hasPermission"],
    "additionalProperties": false
  }
  ```
</Accordion>

## Idempotency

Use a UUID v4 in requestId or the Idempotency-Key HTTP header for each mutation. Reuse the same identifier and identical arguments after a network failure. If both are supplied, they must match. Replaying a saved request does not repeat the operation or charge another monthly call. Failed or interrupted requests are not restarted automatically.

Every mutation can return HTTP 202 when a retry finds the same request still running, even when its first execution is normally synchronous. If execution completed but resultStored is false, a retry returns HTTP 200 with saved request state instead of the original result. Retrieve the output through its domain history, result, or download action.

## 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/voices_clone' \
    --header "x-api-key: $VOICECHEAP_API_KEY" \
    --header 'Content-Type: application/json' \
    --data '{"requestId":"33333333-3333-4333-8333-333333333333","name":"Studio narrator","samples":[{"fileKey":"uploads/example-user/66666666-6666-4666-8666-666666666666-narrator.wav"}],"hasPermission":true,"trimToMaxDuration":false}'
  ```

  ```javascript JavaScript theme={null}
  const input = {
    requestId: '33333333-3333-4333-8333-333333333333',
    name: 'Studio narrator',
    samples: [
      {
        fileKey: 'uploads/example-user/66666666-6666-4666-8666-666666666666-narrator.wav',
      },
    ],
    hasPermission: true,
    trimToMaxDuration: false,
  };
  const response = await fetch('https://api.voicecheap.ai/v1/actions/voices_clone', {
    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_clone",
      headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
      json={"requestId": "33333333-3333-4333-8333-333333333333", "name": "Studio narrator", "samples": [{"fileKey": "uploads/example-user/66666666-6666-4666-8666-666666666666-narrator.wav"}], "hasPermission": True, "trimToMaxDuration": False},
      timeout=120,
  )
  body = response.json()
  if not response.ok:
      raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
  print(body)
  ```
</RequestExample>

## Response

This operation returns HTTP 202 while running. Save requestId and poll action\_request\_get with that identifier and the original operation name. Polling states are running, completed, failed, and interrupted. A completed result can point to a separate media job; continue with the operation-specific status or output action.

The saved reusable custom TTS voice and the updated saved-slot allowance.

<ResponseExample>
  ```json HTTP 202 theme={null}
  {
    "data": {
      "requestId": "33333333-3333-4333-8333-333333333333",
      "status": "running",
      "pollAction": "action_request_get",
      "pollAfterSeconds": 5
    },
    "requestId": "33333333-3333-4333-8333-333333333333"
  }
  ```

  ```json HTTP 200 theme={null}
  {
    "data": {
      "voice": {
        "accent": "original",
        "id": "clone:33333333-3333-4333-8333-333333333333",
        "name": "Studio narrator",
        "previewUrl": "https://files.example.com/saved-narrator.mp3",
        "source": "clone"
      },
      "cloneUsage": {
        "canClone": true,
        "limit": 10,
        "remaining": 9,
        "used": 1
      }
    },
    "requestId": "33333333-3333-4333-8333-333333333333"
  }
  ```

  ```json HTTP 202 replay_running theme={null}
  {
    "data": {
      "requestId": "33333333-3333-4333-8333-333333333333",
      "operation": "voices_clone",
      "createdAt": 1792144800000,
      "updatedAt": 1792144820000,
      "status": "running",
      "pollAfterSeconds": 5
    },
    "requestId": "33333333-3333-4333-8333-333333333333"
  }
  ```

  ```json HTTP 200 replay_completed_without_result theme={null}
  {
    "data": {
      "requestId": "33333333-3333-4333-8333-333333333333",
      "operation": "voices_clone",
      "createdAt": 1792144800000,
      "updatedAt": 1792144820000,
      "status": "completed",
      "resultStored": false,
      "message": "The action completed. Retrieve its output from the corresponding history or resource action."
    },
    "requestId": "33333333-3333-4333-8333-333333333333"
  }
  ```
</ResponseExample>

## Result fields

| Field | Description |
| - | - |
| `data.voice.id` | Reusable TTS selection ID clone:\<UUID>. Use the whole value for tts\_generate and only the UUID for voices\_delete. |
| `data.voice.name` | Saved voice display name. |
| `data.voice.accent` | Saved custom voices use original. |
| `data.voice.source` | Saved custom voices use clone. |
| `data.voice.previewUrl` | Temporary audio preview URL for the saved voice. |
| `data.cloneUsage.canClone` | Whether the current plan permits saved custom TTS voices; inspect remaining for available slots. |
| `data.cloneUsage.limit` | Plan limit for saved custom TTS voice slots. |
| `data.cloneUsage.used` | Occupied TTS voice slots, including reserved creations. |
| `data.cloneUsage.remaining` | Available saved TTS voice slots. |

## Recover and poll this request

Use the same identifier even after a lost connection. If resultStored is false, retrieve the output through the corresponding history, result, or download action. Never start a second generation merely to check progress.

```bash theme={null}
curl --request POST 'https://api.voicecheap.ai/v1/actions/action_request_get' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"requestId":"33333333-3333-4333-8333-333333333333","operation":"voices_clone"}'
```

```json HTTP 200 theme={null}
{
  "data": {
    "requestId": "33333333-3333-4333-8333-333333333333",
    "operation": "voices_clone",
    "status": "completed",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "resultStored": true,
    "result": {
      "voice": {
        "accent": "original",
        "id": "clone:33333333-3333-4333-8333-333333333333",
        "name": "Studio narrator",
        "previewUrl": "https://files.example.com/saved-narrator.mp3",
        "source": "clone"
      },
      "cloneUsage": {
        "canClone": true,
        "limit": 10,
        "remaining": 9,
        "used": 1
      }
    }
  }
}
```

## Operation notes

* Use a UUID v4 requestId for this mutation and reuse it with identical arguments when retrying. Long-running actions first return a running request; this example is the completed handler result available from action\_request\_get.
* Upload 1–3 owned audio samples and use their completed fileKey values. Supported sample formats are MP3, WAV, M4A, OGG, and Opus; each file must be nonempty and at most 20 MiB (20,971,520 bytes). Remote URLs and other accounts’ uploads are refused.
* Samples must total at least 10 seconds and at most 120 seconds of readable audio. trimToMaxDuration defaults to false; set it to true to proportionally trim samples totaling more than 120 seconds.
* hasPermission must be the JSON boolean true, confirming permission for every sample. A string value such as "true" is rejected.
* name must contain 1–80 trimmed characters. Optional language accepts a 2–3 letter code with optional subtags and a maximum of 35 characters.
* This action directly saves the cloned voice and occupies a saved TTS voice slot. It does not consume the one-time clone preview trial.
* Use the returned voice.id in tts\_generate. For a direct clone, its UUID is the requestId; voices\_delete takes that UUID without the clone: prefix.
* The accepted language field does not change the direct-save clone workflow. Choose voices\_preview\_clone when you need a language-specific preview script.
* 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 | `IDEMPOTENCY_CONFLICT` | The Idempotency-Key header and requestId body field must match. |
| 400 | `INVALID_REQUEST_ID` | Supply a UUID v4 requestId or Idempotency-Key. |
| 400 | `VALIDATION_ERROR` | The input does not match the action schema; inspect details for field errors. |
| 400 | `VOICE_CLONE_INVALID_AUDIO` | An uploaded sample has no readable positive audio duration. |
| 400 | `VOICE_CLONE_INVALID_FILE_SIZE` | A stored sample is empty or exceeds 20 MiB. |
| 400 | `VOICE_CLONE_INVALID_FILE_TYPE` | A sample is not MP3, WAV, M4A, OGG, or Opus audio. |
| 400 | `VOICE_CLONE_SAMPLE_TOO_LONG` | The combined samples exceed 120 seconds and trimming was not enabled. |
| 400 | `VOICE_CLONE_SAMPLE_TOO_SHORT` | The combined samples contain less than 10 seconds of audio. |
| 400 | `VOICE_SAMPLE_NOT_OWNED` | A sample key is unsafe or does not belong to the authenticated account. |
| 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 | `ACCOUNT_UNAVAILABLE` | The acting or billing account is unavailable or being deleted. |
| 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. |
| 403 | `VOICE_CLONING_REQUIRES_PAID_PLAN` | The current plan does not permit saved custom TTS voices. |
| 404 | `VOICE_CLONE_NOT_FOUND` | The clone request does not belong to the authenticated account or is no longer available. |
| 409 | `CONCURRENT_ACTION_LIMIT_REACHED` | This account already has 10 integration actions running. Poll an existing request before starting another. |
| 409 | `IDEMPOTENCY_CONFLICT` | Reuse an identifier only with the same operation and arguments. |
| 409 | `VOICE_CLONE_IN_PROGRESS` | A clone using this requestId is still being created. |
| 409 | `VOICE_CLONE_LIMIT_REACHED` | All saved custom TTS voice slots are occupied. |
| 409 | `VOICE_CREATION_IN_PROGRESS` | Voice changes are blocked while account deletion is running. |
| 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. |
| 502 | `INTERNAL_ERROR` | The action could not be completed or its outcome could not be confirmed. Inspect request status and resource history before starting another generation. |
| 503 | `ACTION_RESULT_UNAVAILABLE` | The action ran but its result could not be saved. Inspect saved request state and resource history before starting a new generation. |
| 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": ["voices:write"]
  }
}
```


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