Ir a la guía

API de generación de imágenes para tus propios diseños.

Crea una plantilla visual reutilizable, envía nuevos textos o imágenes como JSON y genera cada variante. Empieza con un PNG y conecta la misma petición a tu aplicación o automatización.

Empieza con una plantilla reutilizable.

Una portada de blog, un certificado o un banner de producto conservan su diseño mientras cambian sus datos. Pikstrapi renderiza la plantilla con los valores que envías; esta guía empieza con una imagen de una sola página.

  1. Guarda una plantilla en el editor visual. Nombra title a la capa de texto para cambiarla con la petición siguiente.
  2. Abre la sección API de tu cuenta. Selecciona la plantilla y copia su ID real y el endpoint que aparece allí.
  3. Crea una API key de la cuenta propietaria de la plantilla. Guárdala en una variable de entorno de servidor o en las credenciales de tu herramienta de automatización.

Abrir el playground de la API de tu cuenta

Envía JSON. Recibe un archivo PNG.

Usa POST con autenticación x-api-key y cuerpo JSON. Guarda este ejemplo como render.json, sustituye YOUR_TEMPLATE_ID por el UUID de tu plantilla y configura PIKSTRAPI_API_KEY en tu terminal.

{
  "templateId": "YOUR_TEMPLATE_ID",
  "exportFormat": "png",
  "mode": "immediate",
  "layers": {
    "title": {
      "text": "Nuevo artículo. Mismo diseño."
    }
  }
}
curl --fail-with-body --request POST "https://api.pikstrapi.com/api/v1/templates/generate-image" \
  --header "x-api-key: $PIKSTRAPI_API_KEY" \
  --header "Content-Type: application/json" \
  --data @render.json \
  --output render.png

El comando usa sintaxis de terminal POSIX. En Windows usa curl.exe y adapta las variables, o utiliza el ejemplo generado por el playground. YOUR_API_BASE_URL representa la URL base con /api/v1 que muestra tu cuenta; sustitúyela si aparece.

Una petición inmediata correcta devuelve HTTP 200 y los bytes del archivo. No devuelve una URL de imagen en JSON. El comando guarda esos bytes en render.png; revisa el error HTTP si falla la generación.

Actualiza las capas que cambian.

El objeto layers usa los nombres guardados de las capas. Usa nombres únicos: si se repiten, solo cambia la primera coincidencia. Por ejemplo, title cambia texto y cover sustituye una imagen. Añade estos cambios a la petición completa con templateId y exportFormat; sustituye el ejemplo de imagen por una URL accesible para el renderizador.

{
  "layers": {
    "title": {
      "text": "Tu próximo lanzamiento",
      "color": "#B74C17"
    },
    "cover": {
      "image_url": "YOUR_PUBLIC_IMAGE_URL"
    }
  }
}

También puedes usar objects: un array de cambios { id, props } con los IDs guardados de los objetos. Si envías ambos, layers se aplica después de objects. Usa el playground para obtener los IDs y nombres de tu plantilla real.

La exportación de imágenes admite png, jpeg y webp. El mismo endpoint admite svg y pdf. Para JPEG usa jpeg, no jpg. Selecciona una sola página para esta primera prueba; varias páginas de imagen producen un ZIP en lugar de un único PNG.

Elige cómo recibir resultado.

Immediate: archivo en respuesta

Usa mode: "immediate" cuando tu cliente espere el archivo. También es el modo por defecto si omites mode. En una herramienta de automatización, configura la respuesta como archivo en lugar de JSON.

Deferred: trabajo cuyo estado puedes consultar

Configura mode: "deferred" para encolar la generación. El endpoint devuelve HTTP 200 con jobId, status, progress y fileId. Este ejemplo ilustra los campos de respuesta; los IDs y el estado reales proceden de tu petición.

{
  "jobId": "YOUR_JOB_ID",
  "status": "queued",
  "progress": 0,
  "fileId": null
}

GET /api/v1/render-jobs/{jobId}, con la misma API key, permite consultar el trabajo. Un trabajo aceptado todavía no es una imagen terminada. Para recibir la finalización o el fallo, añade una webhookUrl HTTP(S) accesible públicamente y procesa render.completed o render.failed.

Seguir guía HTTP Request de n8n

Prueba los datos que recibirá tu diseño.

  • Usa un título largo, caracteres con tildes y una imagen de proporciones distintas. Revisa el archivo exportado al tamaño de uso.
  • Si una capa no cambia, revisa su nombre exacto o ID. La capa debe existir en la plantilla guardada.
  • Ante un error de autenticación, revisa tu API key y la cuenta. Si falla la petición, revisa exportFormat, mode y la estructura del JSON.
  • Confirma que la plantilla pertenece a esa cuenta y quedan créditos. Revisa un timeout incierto antes de repetir: enviar otra petición puede crear otro render.

Una petición. Tu próximo flujo.

Conecta un artículo publicado, un curso completado o una nueva fila de datos con tu plantilla. Empieza por una integración pequeña y comprueba su salida antes de ampliar al lote.

Probar plantilla en API playground

Guía de producto de Pikstrapi. Contrato de petición y respuesta revisado el 9 de octubre de 2026. Los ejemplos requieren tu plantilla, credenciales y datos.