PDF Generation Template Editor

Open-source visual PDF generation engine with customizable templates and developer-friendly APIs.

View on GitHub

Prerequisites ​

Get an API Key ​

  1. Sign in to the ComPDF console.
  2. Create or copy a publicKey from the API Key page.

  1. Keep the key secret. Do not commit it to frontend code or public repositories.

Authentication ​

All ComPDF AI APIs use the API key in the request header:

http
x-api-key: <your-public-key>

Quick validation:

bash
curl --location 'https://api-server.compdf.com/server/v2/asset/info' \
  --header 'x-api-key: <your-public-key>'

code=200 means the key is valid.

Base URLs ​

RegionBase URL
Globalhttps://api-server.compdf.com/server
China mainlandhttps://api-server.compdf.cn/server