One Page PDF Generator

API Reference

/api/render

POST

Generate a PDF from HTML content.

Request Body

{
  "contents": string,    // Required: HTML content to render as PDF
  "width": number,       // Optional: Width of the PDF (default: 172)
  "height": number,      // Optional: Height of the PDF (default: 240)
  "unit": string,        // Optional: Unit for width and height (default: "mm", options: "mm", "cm", "in", "px")
  "out_of_all": boolean  // Optional: Output all pages instead of first page only (default: false)
}

Response

Content-Type: application/pdf
Body: Binary PDF file

Status Codes

200 OK: PDF generated successfully
400 Bad Request: Missing or invalid parameters
500 Internal Server Error: Server error during PDF generation

Example

fetch('/api/render', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    contents: '<html><body><h1>Hello World</h1></body></html>',
    width: 210,
    height: 297,
    unit: 'mm'
  }),
})
.then(response => response.blob())
.then(blob => {
  // Handle the PDF blob
});

/api/:template_name

POST

Generate a PDF from a predefined EJS template with provided data.

Available Templates

colophon - Book colophon page template

Authentication

Requires Bearer token authentication via Authorization header.

Request Body (for colophon template)

{
  "papersize": {
    "width": number,   // Width in mm (e.g., 128.1)
    "height": number   // Height in mm (e.g., 256.1)
  },
  "book": {
    "title": string,   // Book title
    "editions": [      // Optional: Edition information
      {
        "edition_number": string,    // e.g., "初版" or ""
        "printing_number": string,   // e.g., "第１刷" (default: "第１刷")
        "release": {
          "year": number,   // e.g., 2025
          "month": number,  // 1-12
          "day": number     // 1-31
        }
      }
    ],
    "authors": [       // Optional: Author information
      {
        "role": string,  // e.g., "著者"
        "name": string   // e.g., "山田太郎"
      }
    ],
    "isbn": string     // Optional: e.g., "978-4-1111-1111"
  },
  "service_name": string,        // Optional: Publication service name (default: "Puboo")
  "is_paper_publish": boolean    // Optional: Whether it's a paper publication (default: true)
}

Response

Content-Type: application/pdf
Body: Binary PDF file

Status Codes

200 OK: PDF generated successfully
400 Bad Request: Invalid request body
401 Unauthorized: Missing or invalid authentication token
404 Not Found: Template not found
500 Internal Server Error: Server error during PDF generation

Example

curl -X POST https://colophon-server.degg.uk/api/colophon \
  -H "Authorization: Bearer YOUR_TOKEN_HERE" \
  -H "Content-Type: application/json" \
  -d '{
    "papersize": {
      "width": 128,
      "height": 182
    },
    "book": {
      "title": "サンプル書籍",
      "editions": [
        {
          "edition_number": "初版",
          "printing_number": "第１刷",
          "release": {
            "year": 2025,
            "month": 1,
            "day": 15
          }
        }
      ],
      "authors": [
        {
          "role": "著者",
          "name": "山田太郎"
        }
      ],
      "isbn": "978-4-1111-1111"
    },
    "service_name": "Puboo",
    "is_paper_publish": true
  }' -o colophon.pdf

/api/image

POST

Generate an image (PNG or JPEG) from HTML content or URL.

Request Body

{
  "url": string | null,      // Optional: URL to render (takes priority over contents)
  "contents": string | null, // Optional: HTML content to render
  "width": number,           // Optional: Width of the image in pixels (default: 1920)
  "height": number,          // Optional: Height of the image in pixels (default: 1080)
  "format": "jpg" | "png"    // Optional: Output format (default: "png", jpg quality: 90)
}

Response

Content-Type: image/jpeg or image/png (based on format)
Body: Binary image file

Status Codes

200 OK: Image generated successfully
422 Unprocessable Entity: Neither url nor contents provided
500 Internal Server Error: Server error during image generation

Example (with URL)

fetch('/api/image', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    url: 'https://example.com',
    width: 1920,
    height: 1080,
    format: 'png'
  }),
})
.then(response => response.blob())
.then(blob => {
  // Handle the image blob
});

Example (with HTML content)

fetch('/api/image', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    contents: '<html><body><h1>Hello World</h1></body></html>',
    width: 800,
    height: 600,
    format: 'jpg'
  }),
})
.then(response => response.blob())
.then(blob => {
  // Handle the image blob
});

Notes

If both url and contents are provided, url takes priority
JavaScript execution is enabled for dynamic content rendering
Maximum rendering timeout: 30 seconds
Generated images are cached for 24 hours