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

# Diseñar una voz

> Crea voces candidatas a partir de una descripción usando tu cuota de diseño de voces. Escúchalas con voices_preview_get y guarda la vista previa elegida.

Crea voces candidatas a partir de una descripción usando tu cuota de diseño de voces. Escúchalas con voices\_preview\_get y guarda la vista previa elegida.

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

## Autenticación y permisos

<ParamField header="x-api-key" type="string" required>
  Envía una clave de API de VoiceCheap en esta cabecera. También se admite Authorization: Bearer con la misma clave de API. Los tokens de acceso OAuth
  solo se aceptan en MCP, no en este endpoint REST.
</ParamField>

Permisos necesarios: `voices:write`.

Se requiere una suscripción de pago activa. Los permisos no cambian los roles del equipo, la propiedad de los recursos, los créditos multimedia ni los límites del plan.

## Parámetros

<ParamField body="requestId" type="string">
  Opcional en la capa de transporte: el servidor introduce un identificador antes de la validación si se omite. Proporciona tu propio UUID v4 estable para recuperar la solicitud de forma segura si se pierde la respuesta.

  Formato: "uuid". Patrón: `^[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>
  Valor de texto.

  Longitud mínima: 1. Longitud máxima: 80.
</ParamField>

<ParamField body="description" type="string" required>
  Valor de texto.

  Longitud mínima: 1. Longitud máxima: 2000.
</ParamField>

<ParamField body="language" type="string">
  Valor de texto.

  Longitud máxima: 35. Patrón: `^[a-z]{2,3}(-[A-Za-z0-9]{2,8})*$`.
</ParamField>

<Accordion title="Esquema completo de entrada">
  El JSON Schema siguiente conserva los nombres exactos de los campos, los tipos anidados, los valores predeterminados, los límites y los valores aceptados que expone el descubrimiento. Las reglas adicionales entre campos se indican en las notas de la operación.

  ```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
      },
      "description": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2000
      },
      "language": {
        "type": "string",
        "maxLength": 35,
        "pattern": "^[a-z]{2,3}(-[A-Za-z0-9]{2,8})*$"
      }
    },
    "required": ["name", "description"],
    "additionalProperties": false
  }
  ```
</Accordion>

## Idempotencia

Usa un UUID v4 en requestId o en la cabecera HTTP Idempotency-Key para cada modificación. Reutiliza el mismo identificador y argumentos idénticos después de un fallo de red. Si proporcionas ambos, deben coincidir. Repetir una solicitud guardada no vuelve a ejecutar la operación ni consume otra llamada mensual. Las solicitudes fallidas o interrumpidas no se reinician automáticamente.

Toda modificación puede devolver HTTP 202 cuando un reintento encuentra la misma solicitud todavía en ejecución, incluso si su primera ejecución suele ser síncrona. Si la ejecución ha terminado pero resultStored es false, un reintento devuelve HTTP 200 con el estado de la solicitud guardada en lugar del resultado original. Recupera la salida mediante la acción de historial, resultado o descarga de su ámbito.

## Ejemplos de solicitud

Sustituye los identificadores de recursos y las claves multimedia de los ejemplos por valores devueltos para tu cuenta. Mantén el identificador de solicitud al reintentar la misma modificación.

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST 'https://api.voicecheap.ai/v1/actions/voices_design' \
    --header "x-api-key: $VOICECHEAP_API_KEY" \
    --header 'Content-Type: application/json' \
    --data '{"requestId":"284a861a-4da8-4d67-ad48-8123e76c8e91","name":"Studio narrator","description":"A warm, clear English narrator with steady pacing and a natural conversational delivery.","language":"en"}'
  ```

  ```javascript JavaScript theme={null}
  const input = {
    requestId: '284a861a-4da8-4d67-ad48-8123e76c8e91',
    name: 'Studio narrator',
    description: 'A warm, clear English narrator with steady pacing and a natural conversational delivery.',
    language: 'en',
  };
  const response = await fetch('https://api.voicecheap.ai/v1/actions/voices_design', {
    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_design",
      headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
      json={"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "name": "Studio narrator", "description": "A warm, clear English narrator with steady pacing and a natural conversational delivery.", "language": "en"},
      timeout=120,
  )
  body = response.json()
  if not response.ok:
      raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
  print(body)
  ```
</RequestExample>

## Respuesta

Esta operación devuelve HTTP 202 mientras se ejecuta. Guarda requestId y consulta action\_request\_get con ese identificador y el nombre de la operación original. Los estados de consulta son running, completed, failed e interrupted. Un resultado completado puede apuntar a un trabajo multimedia independiente; continúa con la acción de estado o de salida específica de la operación.

Todas las vistas previas activas sin guardar y las cuotas de creación actualizadas, incluidos dos nuevos candidatos de voces diseñadas.

<ResponseExample>
  ```json HTTP 202 theme={null}
  {
    "data": {
      "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
      "status": "running",
      "pollAction": "action_request_get",
      "pollAfterSeconds": 5
    },
    "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
  }
  ```

  ```json HTTP 200 theme={null}
  {
    "data": {
      "voicePreviews": [
        {
          "id": "44444444-4444-4444-8444-444444444444",
          "kind": "design",
          "name": "Studio narrator 1",
          "previewUrl": "https://files.example.com/designed-narrator-1.wav",
          "expiresAt": 1792238400000,
          "durationSeconds": 8
        },
        {
          "id": "55555555-5555-4555-8555-555555555555",
          "kind": "design",
          "name": "Studio narrator 2",
          "previewUrl": "https://files.example.com/designed-narrator-2.wav",
          "expiresAt": 1792238400000,
          "durationSeconds": 9
        }
      ],
      "creationUsage": {
        "cloneTrial": {
          "limit": 1,
          "used": 0,
          "remaining": 1
        },
        "design": {
          "limit": 5,
          "used": 1,
          "remaining": 4,
          "resetsAt": 1792195200000
        },
        "previewExpiresAfterHours": 24
      }
    },
    "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
  }
  ```

  ```json HTTP 202 replay_running theme={null}
  {
    "data": {
      "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
      "operation": "voices_design",
      "createdAt": 1792144800000,
      "updatedAt": 1792144820000,
      "status": "running",
      "pollAfterSeconds": 5
    },
    "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
  }
  ```

  ```json HTTP 200 replay_completed_without_result theme={null}
  {
    "data": {
      "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
      "operation": "voices_design",
      "createdAt": 1792144800000,
      "updatedAt": 1792144820000,
      "status": "completed",
      "resultStored": false,
      "message": "The action completed. Retrieve its output from the corresponding history or resource action."
    },
    "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
  }
  ```
</ResponseExample>

## Campos del resultado

| Campo | Descripción |
| - | - |
| `data.voicePreviews` | Todas las vistas previas actualmente activas sin guardar de esta cuenta, incluidos los candidatos de solicitudes anteriores. |
| `data.voicePreviews[].id` | UUID v4 de vista previa usado por voices\_preview\_get y voices\_save\_preview. |
| `data.voicePreviews[].kind` | clone o design. |
| `data.voicePreviews[].name` | Nombre visible de la vista previa; los candidatos diseñados añaden un número al nombre solicitado. |
| `data.voicePreviews[].previewUrl` | URL temporal de audio reproducible. Solicita una URL nueva con voices\_preview\_get mientras la vista previa siga activa. |
| `data.voicePreviews[].expiresAt` | Caducidad de la vista previa como marca de tiempo Unix en milisegundos. |
| `data.voicePreviews[].durationSeconds` | Duración del audio de vista previa en segundos. |
| `data.creationUsage.cloneTrial` | Cuota de prueba de vista previa de clonación para toda la vida de la cuenta con limit, used y remaining. |
| `data.creationUsage.design` | Cuota diaria de diseño de voces con limit, used, remaining y resetsAt en milisegundos Unix. |
| `data.creationUsage.previewExpiresAfterHours` | Duración de una vista previa sin guardar en horas, actualmente 24. |

## Recuperar y consultar esta solicitud

Usa el mismo identificador incluso después de perder la conexión. Si resultStored es false, recupera la salida mediante la acción correspondiente de historial, resultado o descarga. Nunca inicies una segunda generación solo para comprobar el progreso.

```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":"284a861a-4da8-4d67-ad48-8123e76c8e91","operation":"voices_design"}'
```

```json HTTP 200 theme={null}
{
  "data": {
    "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
    "operation": "voices_design",
    "status": "completed",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "resultStored": true,
    "result": {
      "voicePreviews": [
        {
          "id": "44444444-4444-4444-8444-444444444444",
          "kind": "design",
          "name": "Studio narrator 1",
          "previewUrl": "https://files.example.com/designed-narrator-1.wav",
          "expiresAt": 1792238400000,
          "durationSeconds": 8
        },
        {
          "id": "55555555-5555-4555-8555-555555555555",
          "kind": "design",
          "name": "Studio narrator 2",
          "previewUrl": "https://files.example.com/designed-narrator-2.wav",
          "expiresAt": 1792238400000,
          "durationSeconds": 9
        }
      ],
      "creationUsage": {
        "cloneTrial": {
          "limit": 1,
          "used": 0,
          "remaining": 1
        },
        "design": {
          "limit": 5,
          "used": 1,
          "remaining": 4,
          "resetsAt": 1792195200000
        },
        "previewExpiresAfterHours": 24
      }
    }
  }
}
```

## Notas de la operación

* Usa un requestId UUID v4 para esta mutación y reutilízalo con argumentos idénticos al reintentar. Las acciones de larga duración devuelven primero una solicitud running; este ejemplo es el resultado completado del controlador disponible en action\_request\_get.
* name contiene 1–80 caracteres sin espacios al principio ni al final. description contiene 1–2,000 caracteres sin espacios al principio ni al final. El campo opcional language acepta un código de 2–3 letras con subetiquetas opcionales y un máximo de 35 caracteres.
* Una solicitud de diseño completada correctamente crea dos candidatos kind: design con nombres numerados y consume una solicitud de diseño diaria. Los planes de pago permiten cinco solicitudes por día UTC; consulta creationUsage.design para ver el recuento actual y el momento de restablecimiento.
* Los candidatos duran 24 horas y no son voces TTS reutilizables guardadas. Escúchalos con voices\_preview\_get y luego guarda el candidato seleccionado con voices\_save\_preview.
* La respuesta incluye las vistas previas anteriores que siguen activas y los nuevos candidatos. No se ocupa ningún espacio de voz guardada hasta que se guarda un candidato.
* El historial de síntesis de voz y las voces personalizadas pertenecen a la cuenta autenticada. La facturación del equipo no concede acceso a las síntesis de voz ni a las voces de otro miembro.

## Uso

Cada invocación correcta consume una llamada mensual de API/MCP. También se aplican los créditos multimedia y las cuotas de generación propias de la operación.

## Errores

| Estado HTTP | Código | Significado o solución |
| - | - | - |
| 400 | `CREDENTIAL_IN_QUERY` | Se han proporcionado credenciales en un parámetro de consulta access\_token o api\_key. Envía las credenciales en las cabeceras. |
| 400 | `IDEMPOTENCY_CONFLICT` | La cabecera Idempotency-Key y el campo requestId del cuerpo deben coincidir. |
| 400 | `INVALID_REQUEST_ID` | Proporciona un UUID v4 en requestId o Idempotency-Key. |
| 400 | `VALIDATION_ERROR` | La entrada no coincide con el esquema de la acción; consulta details para ver los errores de los campos. |
| 401 | `API_KEY_EXPIRED` | La clave API ha caducado. |
| 401 | `INVALID_API_KEY` | Proporciona una clave de API válida que no haya caducado. |
| 401 | `INVALID_CREDENTIAL` | La cabecera Authorization tiene un formato incorrecto o entra en conflicto con x-api-key. |
| 401 | `MISSING_CREDENTIAL` | No se proporcionó ninguna credencial de cabecera utilizable o superaba 4096 caracteres. |
| 401 | `USER_NOT_FOUND` | La cuenta de la credencial ya no existe. |
| 403 | `ACCOUNT_UNAVAILABLE` | La cuenta que realiza la acción o la cuenta de facturación no está disponible o se está eliminando. |
| 403 | `AMBIGUOUS_TEAM_API_KEY` | El usuario de la credencial pertenece a más de un equipo, por lo que el contexto de facturación es ambiguo. |
| 403 | `INSUFFICIENT_SCOPE` | Concede todos los permisos necesarios o elige otra credencial. |
| 403 | `INTEGRATION_PLAN_UNSUPPORTED` | No se han podido verificar los límites de integración de la cuenta. |
| 403 | `SUBSCRIPTION_REQUIRED` | Usa una suscripción de pago activa. |
| 403 | `TEAM_OWNER_NOT_FOUND` | No se pudo encontrar la cuenta del propietario efectivo del equipo. |
| 404 | `USER_NOT_FOUND` | La cuenta autenticada ya no existe. |
| 404 | `VOICE_PREVIEW_NOT_FOUND` | La solicitud pertenece a otra cuenta. |
| 409 | `CONCURRENT_ACTION_LIMIT_REACHED` | Esta cuenta ya tiene 10 acciones de integración en ejecución. Consulta una solicitud existente antes de iniciar otra. |
| 409 | `IDEMPOTENCY_CONFLICT` | Reutiliza un identificador solo con la misma operación y los mismos argumentos. |
| 409 | `VOICE_CREATION_IN_PROGRESS` | La vista previa aún se está creando o la eliminación de la cuenta bloquea nuevos trabajos de voz. |
| 409 | `VOICE_CREATION_REQUEST_MISMATCH` | Este requestId se utilizó para un tipo de voz, una configuración o unas muestras diferentes. |
| 409 | `VOICE_DESIGN_LIMIT_REACHED` | Se ha agotado la cuota diaria de diseño de voces. |
| 410 | `VOICE_PREVIEW_EXPIRED` | La vista previa de voz de la solicitud ha caducado o ya no está disponible. |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | Espera al restablecimiento mensual o cambia de plan. |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Espera el tiempo indicado en Retry-After cuando esté presente y aplica esperas progresivas. |
| 500 | `INTERNAL_ERROR` | Comprueba el estado de la solicitud guardada y el historial del recurso antes de decidir si reintentas una modificación. |
| 502 | `INTERNAL_ERROR` | No se pudo completar la acción o confirmar su resultado. Consulta el estado de la solicitud y el historial del recurso antes de iniciar otra generación. |
| 503 | `ACTION_RESULT_UNAVAILABLE` | La acción se ejecutó, pero no se pudo guardar su resultado. Revisa el estado de la solicitud guardada y el historial del recurso antes de iniciar una nueva generación. |
| 503 | `SERVER_RESTARTING` | El servidor se está reiniciando. Reinténtalo en breve y conserva el mismo identificador de solicitud para una modificación. |

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