After you sign up, you can create "API Access Keys", unique keys bound to your account to perform conversions. When performing a conversion, you need to specify such an API key in the headers of the HTTP-request:

X-Api-Key: PDF-00000000-0000-0000-0000-000000000000

You can define as many API Access keys as you would like. Usage statistics are available for each separate key.

When you send a conversion request to the API to convert HTML to PDF, you need to specify the details we need to create your PDF document. You can specify this in the request body, formatted as JSON. The table below contains all properties the body can have when performing a conversion.

Send your request as a POST to:

https://api.opexpdf.com/conversion/html

When you send a conversion request to the API to convert a URL to PDF, you need to specify the details we need to create your PDF document. You can specify this in the request body, formatted as JSON. The table below contains all properties the body can have when performing a conversion.

Send your request as a POST to:

https://api.opexpdf.com/conversion/url

All requests to the API are rate limited based on your current subscription plan:

On every request made, we will check the number of requests performed during the minute before. If your subscription plan's limit has been exceeded, the API will return an error "429: Too Many Request". See the section about API error codes for more details.

When your conversion request succeeds, the API will return the converted pdf document and the typical "200 OK" http response status code. However, when the request fails one of the statuscodes below will be returned:

Following RFC7807 all errors contain the error details in the response body. An example response for when you forget to include a valid API access key would be:

{
    "type": "https://tools.ietf.org/html/rfc7235#section-3.1",
    "title": "Unauthorized",
    "status": 401,
    "traceId": "|19ff80b6-4076a96ebc142c99."
}

Please include these details if possible when contacting our support team.

If you are interested in the usage statistics for the current billing period, you can get these by executing the following GET-request:

• Request URL:

  https://api.opexpdf.com/usage

• Add the API key to the request headers:

  X-Api-Key: PDF-000000-0000-0000-0000000000 <-- replace with the key from your account

The API will respond with the following:

{
    "conversionsTotal": 1000,
    "conversions": 553,
    "conversionsRemaining": 447
}

OpexPDF supports a great number of predefined page sizes; the default is set to A4. See the list below for all predefined sizes.

In case you need to set a custom papersize, you need to set the paperSize property to Custom and specify the papersize manually:

In OpexPDF you can easily define headers and footers for your PDF document. Just include html-code in the appropriate properties in your request body, and the code will be rendered on top and at the bottom of every page in the resulting document.

The HTML you pass in headerHtmlContent or footerHtmlContent can be a complete HTML document or or just an HTML fragment. It uses separate styling from the main content; you should include your styling in the HTML when adding headers or footers.

When using headers and footers, you should specify the height of the header or footer in the conversion request body, by setting headerHeight or footerHeight to the required height in millimeters.

There are a few metadata placeholders you can use in your headers and footers:

OpexPDF supports a lot of other options when converting HTML to PDF documents. The table below contains all properties the options-object can have when performing a conversion.

To integrate easily into your application, you can use our Swagger/OpenAPI file that describes the API. The file can be found here.

With this file, you can easily generate code in the language of your choice that you can use to call the API. Generators are available for many languages, but these are some of the more common ones: