Preview PDF

Send a POST request to this endpoint to print your HTML as a PDF without storing it. The response is the PDF itself, stamped “Preview” on every page.

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

A preview costs no credits and is not stored. You can send 30 previews per hour. To keep the PDF at a link, use Create PDF from HTML.

Request


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

Headers

Header	Value	Description
Content-Type	text/html	Specify that the request body contains HTML

Request Body

The request body should contain the HTML you want to print. Page size and margins follow the same rules as in Create PDF from HTML.

cURL


curl --request POST \
  --url https://api.ojo.so/v1/pdf/preview \
  --header 'Authorization: Bearer <your API key>' \
  --header 'Content-Type: text/html' \
  --data '<html><body><h1>Invoice #1024</h1><p>Total: $120.00</p></body></html>' \
  --output preview.pdf

Python


import requests
 
url = "https://api.ojo.so/v1/pdf/preview"
payload = "<html><body><h1>Invoice #1024</h1><p>Total: $120.00</p></body></html>"
headers = {
    "Authorization": "Bearer <your API key>",
    "Content-Type": "text/html",
}
 
response = requests.post(url, data=payload, headers=headers)
with open("preview.pdf", "wb") as file:
    file.write(response.content)

JavaScript


import { writeFile } from 'node:fs/promises';
 
const response = await fetch('https://api.ojo.so/v1/pdf/preview', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <your API key>',
    'Content-Type': 'text/html',
  },
  body: '<html><body><h1>Invoice #1024</h1><p>Total: $120.00</p></body></html>',
});
 
await writeFile('preview.pdf', Buffer.from(await response.arrayBuffer()));

Response

200

The PDF, as application/pdf. X-Pdf-Pages gives the number of pages. X-Render-Warnings lists the resources the page could not load, as a percent-encoded JSON array of strings, and is left out when there were none.


HTTP/1.1 200 OK
Content-Type: application/pdf
X-Pdf-Pages: 2
 
<the PDF>

401

Your API key might be invalid or expired.


{
  "error": true,
  "message": "Unauthorized",
  "status": 401,
  "title": "Unauthorized",
  "detail": "Unauthorized"
}

415

The body was sent with another Content-Type than text/html.


{
  "error": true,
  "message": "Unsupported Media Type",
  "logs": ["Send the HTML with Content-Type: text/html"],
  "status": 415,
  "title": "Unsupported Media Type",
  "detail": "Unsupported Media Type"
}

422

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


{
  "error": true,
  "message": "Unprocessable Entity",
  "logs": ["Template missing. Send html in the request body"],
  "status": 422,
  "title": "Unprocessable Entity",
  "detail": "Unprocessable Entity"
}

429

You have sent 30 previews in the last hour. You can view rate limit details here.


{
  "error": true,
  "message": "PDF preview limit reached: 30 previews per hour",
  "logs": ["Try again in 30 minutes."],
  "code": "rate_limited.pdf_preview",
  "retryAfter": 1800,
  "status": 429,
  "title": "Too Many Requests",
  "detail": "PDF preview limit reached: 30 previews per hour"
}

500

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


{
  "error": true,
  "message": "Internal Server Error",
  "status": 500,
  "title": "Internal Server Error",
  "detail": "Internal Server Error"
}