HTTP API

DW
Last updated 2 months ago

HTTP API endpoint for submitting a URL to rendered as a PDF.

post
Submit a Public URL for rendering

https://breezypdf.com
/api/pdf/public_urls
Submit a public URL for rendering
Request
Response
Headers
Authorization
required
string
Secret API key Bearer token Bearer SECRET_API_KEY
Form Data Parameters
url_to_render
required
string
Fully qualified URL of the html webpage to render as a PDF
metadata
optional
object
Data that describes the request.
200: OK
Cake successfully retrieved.
{
"id": "1234-abc-56789",
"state": "requested",
"download_url": "https://relay.breezypdf.com/pdf/1234-abc-56789",
"meta": {
"other_supplied_meta": "foobar"
}
}

post
Submit a HTML string for rendering

https://breezypdf.com
/api/pdf/public_urls
Submit a HTML string for rendering
Request
Response
Path Parameters
Authorization
required
string
Secret API key Bearer token Bearer SECRET_API_KEY
Form Data Parameters
metadata
optional
string
Data that describes the request.
html_slug
required
string
Full HTML string to be renderd. <html><body><h1>Hello!</h1></body></html>
200: OK
{
"id": "1234-abc-56789",
"state": "requested",
"download_url": "https://relay.breezypdf.com/pdf/1234-abc-56789",
"meta": {
"other_supplied_meta": "foobar"
}
}