Skip to main content
POST
Crea una vista previa temporal de una voz clonada a partir de 1–3 archivos de audio cargados de tu propiedad, con permiso explícito. Aplica la cuota de prueba de clonación de la aplicación. Guarda la vista previa seleccionada antes de que caduque para conservarla.

​
Autenticación y permisos

​
string
requerido
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.
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

​
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}$.
​
string
requerido
Valor de texto.Longitud mínima: 1. Longitud máxima: 80.
​
array
requerido
Lista de valores. Consulta la estructura de sus elementos en el esquema completo de entrada.Número mínimo de elementos: 1. Número máximo de elementos: 3.
​
boolean
requerido
Confirma que tienes permiso para clonar a la persona cuya voz aparece en cada muestra.Valor obligatorio: true.
​
boolean
Valor booleano.Valor predeterminado: false.
​
string
Valor de texto.Longitud máxima: 35. Patrón: ^[a-z]{2,3}(-[A-Za-z0-9]{2,8})*$.
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.

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

​
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 de voz activas sin guardar y las cuotas de creación actualizadas, incluido el nuevo candidato de clonación.

​
Campos del resultado

​
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.
HTTP 200

​
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.
  • Carga entre 1–3 muestras de audio propias y usa sus valores fileKey completados. Los formatos de muestra compatibles son MP3, WAV, M4A, OGG y Opus; cada archivo debe tener contenido y un máximo de 20 MiB (20,971,520 bytes). Se rechazan las URL remotas y las cargas de otras cuentas.
  • Las muestras deben sumar al menos 10 segundos y como máximo 120 segundos de audio legible. El valor predeterminado de trimToMaxDuration es false; establécelo en true para recortar proporcionalmente las muestras que sumen más de 120 segundos.
  • hasPermission debe ser el booleano JSON true, que confirma el permiso para cada muestra. Se rechaza un valor de cadena como “true”.
  • name debe contener entre 1–80 caracteres tras eliminar los espacios al principio y al final. El campo opcional language acepta un código de 2–3 letras con subetiquetas opcionales y un máximo de 35 caracteres.
  • Usa la única prueba de vista previa de clonación de la cuenta, disponible una sola vez. Crear esta vista previa no guarda una voz TTS reutilizable ni ocupa una plaza de voz guardada.
  • El nuevo candidato de clonación tiene kind: clone y dura 24 horas. Su reproducción está limitada a aproximadamente 10 segundos.
  • La respuesta incluye todas las vistas previas activas sin guardar. Usa voices_preview_get para renovar la reproducción y luego voices_save_preview para conservar el candidato elegido con un plan de pago.
  • language elige el guion de la vista previa cuando existe un guion compatible; no es una solicitud de traducción de la muestra subida.
  • 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