Skip to main content
POST
Genera una miniatura de 1280×720 para la cuenta conectada con la cuota multimedia de la aplicación web. Reutiliza requestId al reintentar la misma solicitud; usa thumbnails_download para recuperar el resultado.

​
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: thumbnails: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: 10. Longitud máxima: 1200.
​
array
Lista de valores. Consulta la estructura de sus elementos en el esquema completo de entrada.Número máximo de elementos: 3. Valor predeterminado: [].
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. Metadatos finales de la miniatura devueltos al finalizar la generación. El resultado es de 1280 × 720 píxeles; no incluye los bytes de la imagen, previewDataUrl ni los tokens de transferencia.

​
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

  • Requiere thumbnails:write. Se eliminan los espacios de los extremos del prompt, que debe contener entre 10 y 1200 caracteres; también se normaliza antes de la generación. referenceImageKeys tiene como valor predeterminado [] y acepta como máximo tres claves.
  • Esta es una acción de larga duración. La respuesta inicial de API/MCP normalmente indica running; consulta periódicamente action_request_get con operation thumbnails_generate y el mismo requestId para obtener el resultado final que se muestra aquí.
  • Usa la cuota diaria habitual de generación de miniaturas de la cuenta. Las nuevas miniaturas de la cuenta caducan siete días después de su creación; descarga el resultado antes de expiresAt.
  • Esta acción usa las creaciones y cargas propias del usuario conectado, también cuando la credencial está conectada en un contexto de equipo.
  • Las claves de referencia deben apuntar a cargas completadas en uploads/{yourUserId}/ y terminar en .jpg, .jpeg, .png o .webp. Se rechazan las URL remotas, las claves de otros usuarios, los segmentos de recorrido de rutas, las barras invertidas, las secuencias de escape con porcentaje, las cadenas de consulta, los fragmentos y los caracteres de control.
  • Cada referencia debe tener contenido, ocupar como máximo 8 MiB (8,388,608 bytes), descodificarse como el tipo de imagen indicado por su extensión y medir entre 128–4096 píxeles en cada lado. El número de píxeles descodificados también está limitado. Una referencia cargada sigue siendo reutilizable; estas acciones de generación no consumen ni eliminan su archivo cargado.
  • Usa un requestId UUID v4 o la cabecera HTTP Idempotency-Key, y reutilízalo con entradas idénticas al reintentar. La capa de integración registra cada modificación y devuelve su estado o resultado registrado sin volver a ejecutarla. Una solicitud fallida o interrumpida no se reintenta automáticamente.
  • Una solicitud completada puede devolver la miniatura existente. Una solicitud de integración que haya fallado o se haya interrumpido no se vuelve a ejecutar automáticamente. Revisa el estado de la solicitud y thumbnails_list antes de iniciar una nueva solicitud.
  • Usa thumbnails_get o thumbnails_list para los metadatos y thumbnails_download para los bytes WebP. El identificador de generación es una cadena opaca, no requestId.

​
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