Skip to main content
POST
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.

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.
string
requerido
Valor de texto.Longitud mínima: 1. Longitud máxima: 2000.
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 activas sin guardar y las cuotas de creación actualizadas, incluidos dos nuevos candidatos de voces diseñadas.

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