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

# Obtener una vista previa de voz

> Obtén una URL temporal reproducible para la vista previa de tu voz clonada o diseñada aún sin guardar. Usa voices_save_preview para conservarla antes de que caduque.

Obtén una URL temporal reproducible para la vista previa de tu voz clonada o diseñada aún sin guardar. Usa voices\_save\_preview para conservarla antes de que caduque.

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

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

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="previewId" type="string" required>
  Valor de texto.

  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>

<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": {
      "previewId": {
        "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})$"
      }
    },
    "required": ["previewId"],
    "additionalProperties": false
  }
  ```
</Accordion>

## 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_preview_get' \
    --header "x-api-key: $VOICECHEAP_API_KEY" \
    --header 'Content-Type: application/json' \
    --data '{"previewId":"44444444-4444-4444-8444-444444444444"}'
  ```

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

## Respuesta

Una primera ejecución correcta devuelve HTTP 200 con el resultado de la operación en data. Una repetición puede devolver el estado de la solicitud guardada en su lugar. El ejemplo muestra una respuesta admitida, no todos los campos opcionales.

Una vista previa de voz activa que pertenece a la cuenta, con una URL temporal de reproducción renovada y su caducidad.

<ResponseExample>
  ```json HTTP 200 theme={null}
  {
    "data": {
      "id": "44444444-4444-4444-8444-444444444444",
      "kind": "clone",
      "name": "Studio narrator",
      "previewUrl": "https://files.example.com/narrator-preview.mp3",
      "expiresAt": 1792238400000,
      "durationSeconds": 10
    }
  }
  ```
</ResponseExample>

## Campos del resultado

| Campo | Descripción |
| - | - |
| `data.id` | UUID del candidato para voices\_save\_preview. |
| `data.kind` | clone o design. |
| `data.name` | Nombre visible del candidato. |
| `data.previewUrl` | Nueva URL temporal de audio reproducible. |
| `data.expiresAt` | Caducidad del candidato como marca de tiempo Unix en milisegundos. |
| `data.durationSeconds` | Duración del audio de vista previa en segundos. |

## Notas de la operación

* previewId es el UUID del candidato devuelto en voicePreviews por voices\_preview\_clone, voices\_design o voices\_list.
* Solo se muestran las vistas previas listas, sin guardar y no caducadas. Un candidato guardado pasa a voices\_list como clone:\<previewId>. Los candidatos caducados, guardados, ausentes o de otro propietario devuelven aquí VOICE\_PREVIEW\_NOT\_FOUND.
* La URL es temporal y puede caducar antes de expiresAt. Guarda el candidato elegido con voices\_save\_preview antes de que caduque la propia vista previa.
* 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 | `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 | `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 vista previa no existe, no pertenece a la cuenta, ya está guardada o ha caducado. |
| 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. |
| 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:read"]
  }
}
```


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