Ir a la guía

Genera documentos PDF desde tus plantillas visuales.

Conserva tu certificado, portada o documento de marca en una plantilla reutilizable. Envía los datos por API y descarga una página o combina varios trabajos PDF completados en un documento.

Usa PDF para un diseño visual fijo.

El renderizador coloca una imagen rasterizada del lienzo en la página PDF. Tu diseño guardado determina el resultado, incluidos los textos, logotipos e imágenes. Sirve para certificados, portadas y documentos con una distribución visual fija.

El PDF no contiene texto editable o que puedas buscar, campos rellenables ni párrafos que se distribuyan automáticamente entre páginas. Si necesitas esas funciones, evalúa un renderizador de documentos compatible antes de elegir este flujo.

Para generar una página, selecciona su diapositiva. Una petición que renderiza varias diapositivas devuelve un ZIP con archivos separados, también cuando eliges PDF. Para obtener un PDF combinado, genera trabajos PDF individuales y combínalos como indica esta guía.

Genera una página y conserva el ID del trabajo.

Guarda tu plantilla, asigna el nombre title a la capa de texto variable y obtén el ID de la plantilla y una API key de la misma cuenta. Guarda este ejemplo como page.json y sustituye YOUR_TEMPLATE_ID. slidePosition empieza en uno: 1 selecciona la primera diapositiva.

{
  "templateId": "YOUR_TEMPLATE_ID",
  "exportFormat": "pdf",
  "mode": "deferred",
  "slidePosition": 1,
  "pageFormat": "a4",
  "layers": {
    "title": {
      "text": "Título de tu documento"
    }
  }
}

Este ejemplo usa A4. El renderizador ajusta el lienzo proporcionalmente dentro de la página y elige la orientación según sus dimensiones. Previsualiza tu diseño para revisar los márgenes y el tamaño efectivo de la imagen.

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 @page.json

Los comandos usan sintaxis POSIX y una variable de entorno para tu API key. En Windows, usa curl.exe y adapta las variables y la continuación de líneas, o utiliza el ejemplo generado por el playground. Si aparece YOUR_API_BASE_URL, sustitúyela por la URL base que muestra el playground, incluido /api/v1. La generación diferida devuelve HTTP 200 con jobId, status, progress y fileId. Conserva jobId como identificador de esta página.

Para generar la segunda página de tu plantilla, envía otra petición con slidePosition: 2 y conserva su jobId por separado. Para crear documentos distintos desde la misma página, mantén slidePosition y cambia los datos de las capas.

Si solo necesitas un PDF inmediato, configura mode como immediate. El endpoint devuelve los bytes del PDF con application/pdf; guárdalos como archivo, sin interpretarlos como JSON. Usa trabajos diferidos cuando necesites los IDs de los trabajos completados para combinarlos.

Espera a que cada página esté completada.

Consulta el trabajo con una API key de la misma cuenta. Sustituye YOUR_JOB_ID por el jobId de la respuesta de renderizado. Comprueba status, además de progress, antes de añadir el trabajo a la petición de combinación.

curl --fail-with-body "https://api.pikstrapi.com/api/v1/render-jobs/YOUR_JOB_ID" \
  --header "x-api-key: $PIKSTRAPI_API_KEY"

Los trabajos con estado queued o processing aún no están listos. Un trabajo completed debe tener fileId y una salida PDF. Gestiona las páginas fallidas o canceladas por separado. Tras agotar el tiempo de espera de la conexión, consulta el trabajo existente antes de solicitar otro renderizado.

En un flujo recurrente, el webhook render.completed puede iniciar el siguiente paso. Conserva el orden de las páginas en los datos de tu flujo: el orden de finalización puede ser distinto al del documento.

Combina los PDF en el orden que indiques.

Guarda este cuerpo como merge.json. Sustituye ambos valores por UUID distintos de trabajos PDF completados de tu cuenta. renderIds recibe IDs de trabajos de renderizado, no IDs de archivos o plantillas ni URL de descarga.

{
  "renderIds": [
    "YOUR_FIRST_COMPLETED_PDF_JOB_ID",
    "YOUR_SECOND_COMPLETED_PDF_JOB_ID"
  ]
}
curl --fail-with-body --request POST "https://api.pikstrapi.com/api/v1/render-jobs/merge-pdf" \
  --header "x-api-key: $PIKSTRAPI_API_KEY" \
  --header "Content-Type: application/json" \
  --data @merge.json \
  --output combined.pdf

La respuesta correcta es HTTP 200 con application/pdf. El comando guarda los bytes en combined.pdf. La combinación conserva las páginas y tamaños de cada entrada en el orden de renderIds. No crea otro trabajo de renderizado ni consume créditos adicionales; generar los PDF de entrada sí usa los créditos habituales.

Comprueba los archivos antes de combinarlos.

  • Envía entre 2 y 20 IDs distintos de trabajos PDF completados de la misma cuenta.
  • El tamaño total de las entradas y el PDF de salida tienen un límite de 20 MiB cada uno. La salida admite hasta 200 páginas.
  • Este endpoint no acepta salidas ZIP, trabajos de imagen, archivos PDF subidos de forma independiente ni URL externas.
  • Un trabajo que aún se está generando impide la combinación. Si el PDF es inválido o está cifrado, se rechaza: lee el error antes de reintentar.

Revisa el documento al tamaño previsto.

Abre combined.pdf en un visor PDF y comprueba el número de páginas, su orden, los textos largos, las tildes y la calidad de imagen. Si vas a imprimirlo, prueba el tamaño real del papel. Valida dos páginas de muestra antes de conectar tus datos reales.

Probar tu plantilla PDF en el playground

Ejemplos de API revisados con el contrato de renderizado y combinación de PDF de Pikstrapi el 9 de octubre de 2026. Sustituye los valores de ejemplo y valida los archivos resultantes en tu cuenta.