Skip to main content

Use REST API

In this guide, we will explore how to use the HTML-to-PDF.io OpenAPI specification to build REST API clients for your projects.

Why build your own?

Although we highly recommend using one of our managed SDKs, we recognise there are cases where you'd rather manage your own REST client.

To this end, we publish our Open API specs so you can reliably build and test your clients.

General guidance

Before getting started, ensure that you have a solid understanding of REST APIs and their basic principles. Familiarity with one or more of the programming languages mentioned below is also necessary.

Select Open API Spec

We don't make breaking changes to a released API version. For that reason, we'll occassionally release a new version instead with a published OpenAPI spec.

We do offer a "latest" spec, but for most developers we'd recommend selecting the latest locked version you find below:

VersionJSON URL
1.x.x (recommended)https://raw.githubusercontent.com/HTML-to-PDF/open-api-spec/main/open-api-spec.v1.json
latesthttps://raw.githubusercontent.com/HTML-to-PDF/open-api-spec/main/open-api-spec.json

For the latest list, all specs are published to our dedicated open-api-spec Github repository.

Using your chosen spec

Your chosen spec will specify what auth, paths, and types are required for that version of the API. You can use this common format to automatically generate a client for most languages with the tools below, or build your own.

Suggested generators, in no particular order: