Skip to main content

REST API

CraftMyPDF exposes a complete REST API that lets you generate PDFs and images, manage templates, and manipulate documents from any programming language or platform that can issue HTTP requests. The API uses standard JSON request and response bodies, API key authentication, and supports both synchronous and asynchronous PDF generation.

What you can do with the REST API​

The REST API covers the full PDF generation lifecycle, including:

  • Generating PDFs and images from your existing templates by passing JSON data.
  • Creating, updating, listing, and deleting templates programmatically.
  • Merging multiple PDFs, splitting documents, and converting PDFs to images.
  • Polling generation status for long-running asynchronous PDF jobs.
  • Uploading custom assets such as fonts and images for use in templates.

Authentication and endpoints​

All API calls are authenticated with an API key issued from your CraftMyPDF account. Requests are made over HTTPS to regional endpoints — see Regional API endpoints for the full list of base URLs and recommended region selection.

Full API reference​

For the complete list of endpoints, request and response schemas, error codes, rate limits, and code samples in multiple languages, see the official documentation: