Create PDF from Template

Send a POST request to this endpoint to render one of your templates into a PDF document.

ℹ️

You will need to authenticate to use this API. See authentication.

ℹ️

This endpoint consumes 1 credit per PDF, up to 20 pages. A PDF longer than 20 pages is refused and costs nothing.

Request


POST https://api.ojo.so/v1/pdf/template

Request Body

Parameter	Type	Description
templateId	string	The ID of the template to use
modify	object	(Optional) An object containing variables to modify in the template

Pages are A4 by default. A CSS @page rule in the template sets the size and margins, as described in Create PDF from HTML. A template variable works there too, so one template can serve both sizes:


@page {
  size: {{pageSize}};
}

cURL


curl --request POST \
  --url https://api.ojo.so/v1/pdf/template \
  --header 'Authorization: Bearer <API Key>' \
  --header 'Content-Type: application/json' \
  --data '{"templateId": "<Template ID>", "modify": {"customer": "Acme Inc.", "pageSize": "letter"}}'

Python


import requests
 
url = "https://api.ojo.so/v1/pdf/template"
payload = {
    "templateId": "<Template ID>",
    "modify": {"customer": "Acme Inc.", "pageSize": "letter"},
}
headers = {"Authorization": "Bearer <API Key>"}
 
response = requests.post(url, json=payload, headers=headers)
print(response.text)

JavaScript


const response = await fetch('https://api.ojo.so/v1/pdf/template', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <API Key>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    templateId: '<Template ID>',
    modify: { customer: 'Acme Inc.', pageSize: 'letter' },
  }),
});
 
console.log(await response.json());

Response

200

Everything went as planned and your PDF is generated.


{
  "id": "pdf-id.pdf",
  "pdfUrl": "<content domain>/path/to/document.pdf",
  "pages": 1,
  "createdAt": "2026-09-28T12:34:56Z"
}

pdfUrl has no scheme. Prefix it with https:// to fetch the file.

401

Your API key might be invalid or expired.


{
  "error": true,
  "message": "Unauthorized"
}

402

Your credits are depleted. You need to purchase more credits to use the API.


{
  "error": true,
  "message": "Payment Required"
}

422

Request payload unprocessable, or the PDF is longer than 20 pages. The reason is in logs. Update the request and try again.


{
  "error": true,
  "message": "Unprocessable Entity",
  "logs": ["Template not found"]
}

429

You have hit your rate limit. You can view rate limit details here.


{
  "error": true,
  "message": "Too Many Requests"
}

500

An unexpected error occurred. Try again later. If the issue persists, please reach out.


{
  "error": true,
  "message": "Internal Server Error"
}