The OpenAPI 3.0 specification for the PodPDF API: generate PDFs from HTML, Markdown, URLs, images and saved templates, and merge, split, password-protect, unlock or edit existing documents.

npm install ipodpdf

import spec from 'ipodpdf' with { type: 'json' };
// or: const spec = require('ipodpdf');
console.log(Object.keys(spec.paths));

The package ships both formats:

File	Use
`openapi.json`	the package's main export; what most tools import
`openapi.yaml`	the source, for reading and diffs

Generate a client

npx @openapitools/openapi-generator-cli generate \
  -i node_modules/ipodpdf/openapi.yaml -g typescript-fetch -o ./podpdf-client

Or types only:

npx openapi-typescript node_modules/ipodpdf/openapi.yaml -o podpdf.d.ts

What is covered

Every endpoint an API key can call: /quickjob, /longjob, /bulkjob, the job and download routes, /templates/{id}/render, the PDF tools (merge, split, inspect, upload-url, jobs), the PDF editor (edit, edit/preflight, extract), /me, and the public plan list.

The dashboard-only routes — account, billing, API key and webhook management, template CRUD, job listing — are left out on purpose: they need a Cognito ID token, and an API key is rejected on them at the gateway.

Authentication

Every request sends the key as a header:

X-API-Key: pk_your_key_here

Create one at app.podpdf.com under Settings → API Keys. Each successful PDF costs $0.01 from credits that never expire; an account with no paid plan gets 402 UPGRADE_REQUIRED.

Versioning

The package version tracks info.version in the spec, and a test enforces that. A patch covers wording and examples, a minor an added endpoint or field, and a major a breaking change to the API itself.

Docs: apidocs.podpdf.com · Support: podpdfapp@gmail.com