PDFMint API
HTML, Markdown, URL and template rendering to PDF and images over a simple JSON API. The human-readable reference lives at https://pdf.mintapis.com/docs; this…
Developer tools#documents--productivity
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
HTML, Markdown, URL and template rendering to PDF and images over a simple JSON API. The human-readable reference lives at https://pdf.mintapis.com/docs; this document is the machine-readable OpenAPI 3.1 description of the same endpoints. Authentication uses either Authorization: Bearer or x-api-key: ; keys start with pm_live_. Every authenticated endpoint is rate-limited to 120 requests per minute per account with a burst of 30 (headers X-RateLimit-Limit, X-RateLimit-Burst, X-RateLimit-Remaining; a 429 carries Retry-After). App-level errors that are not tied to one operation — unknown_endpoint (404), invalid_json (400), request_too_large (413) and internal_error (500) — are documented once in the top-level x-app-level-errors section; every operation-specific error code is listed on the operation it can hit.
Endpoints 16
render
- POSTKeyless demo render (HTML only)
/v1/demo/pdfRenders HTML to PDF without an API key. Only "html" is honoured; anything else in the body is ignored. Capped at 16 KB of HTML and 5 renders per hour per… - POSTRender HTML, Markdown, a URL or a stored template to PDF
/v1/pdfCosts 1 credit. Synchronous by default (binary/url/base64 output); with "async": true or a "webhookUrl" it queues a job instead and returns 202 with a… - POSTRender HTML, Markdown or a URL to a PNG or JPEG
/v1/imageCosts 1 credit. Screenshots the rendered page; saved templates are not supported here. - POSTMerge 2-50 PDFs into one
/v1/mergeCosts 1 credit. Each input is a public http(s) URL, a base64 string, or {"base64": "..."}.
account
- GETAccount balance and plan
/v1/meReturns the authenticated account’s plan, monthly credit usage and when the period resets (on the 1st of the month, UTC).
templates
- GETList stored templates
/v1/templates - GETFetch a stored template
/v1/templates/:name - PUTCreate or replace a stored template
/v1/templates/:nameNames are 1-64 characters of letters, digits, spaces, dot, dash or underscore; the body is up to 2 MB of HTML with {{placeholders}}. Optional "options" are… - DELETEDelete a stored template
/v1/templates/:name
keys
- GETList active API keys
/v1/keys - POSTIssue a new API key
/v1/keysReturns the full key once; it cannot be read back afterwards. Optional "label" is truncated to 40 characters. - DELETERevoke an API key by its prefix
/v1/keys/:prefixTakes effect on the next request. Refuses to revoke the account’s last remaining key.
jobs
- GETPoll an asynchronous render job
/v1/jobs/:idReturns the job’s status; when succeeded it carries the hosted result fields (url, filename, pages, size, expires_in_minutes, duration_ms). Finished jobs are… - DELETECancel a queued or running job
/v1/jobs/:idMarks the job cancelled and refunds the credit it consumed. The result of an already-finished job cannot be cancelled.
recovery
- POSTRequest a password-reset link
/v1/forgot-passwordAlways answers the same whether or not the account exists. Rate-limited to 5 attempts per hour per client IP address. - POSTComplete a password reset
/v1/reset-passwordConsumes the single-use token from the reset email (valid 30 minutes). Password: at least 8 characters, at most 72 UTF-8 bytes.
API details
- Base URL
https://pdf.mintapis.comhttps://pdfmint-b9tt.onrender.com- Authentication
- A bearer token in the Authorization header
An API key in the x-api-key header - Operations
- 16 operations on 12 pathsPOST 7GET 5DELETE 3PUT 1
- Main resources
- render 4templates 4keys 3jobs 2recovery 2account 1
- Response formats
application/jsonapplication/pdfimage/jpegimage/png- Description format
- OpenAPI 3.1.0, API version
1.0.0 - Links
- OpenAPI document
- Listed from
- Mintapis's published OpenAPI description
How to test the PDFMint API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the PDFMint API collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Keyless demo render (HTML only)” (POST /v1/demo/pdf), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the PDFMint API?
HTML, Markdown, URL and template rendering to PDF and images over a simple JSON API. The human-readable reference lives at https://pdf.mintapis.com/docs; this… It is listed under Developer tools and has 16 endpoints.
Who publishes the PDFMint API?
It is listed from Mintapis's public API description (an OpenAPI document), not published by Mintapis on Swastik Codes. Anyone who controls pdf.mintapis.com can claim the profile by adding a DNS TXT record.
What is the base URL of the PDFMint API?
Its description lists 2 base URLs: https://pdf.mintapis.com, https://pdfmint-b9tt.onrender.com. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the PDFMint API?
It accepts 2 methods: A bearer token in the Authorization header; an API key in the x-api-key header.
How many endpoints does the PDFMint API have?
16 operations on 12 paths (7 POST, 5 GET, 3 DELETE, 1 PUT). The largest groups are render, templates, keys, jobs.
Is forking the PDFMint API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.