Getting Started

Render PDFs from your applications with the Tuix PDF Service.

What is the Tuix PDF Service?

The Tuix PDF Service turns HTML templates into PDF files through a simple API. You render a PDF by referencing an application (applicationId) and a template (templateId), passing the template variables as data. The service renders the HTML, converts it to a PDF and answers with the URL the generated file is served from. That URL is an endpoint of the service, so fetching the file needs your API key, see Download a PDF.

One request can render several documents at once.

Before you render

Before rendering your first PDF, set up the following in the Tuix dashboard:

Create an account: open Tuix PDF, click Login and sign up on the login page.

Create an application.

Create a template with the HTML content.

Generate an API key.

Render a PDF

Once the steps above are done, render in one of these ways:

Install the client

Install the npm package and render with the typed client.

Render with fetch

Fallback without the npm package, straight against the REST API.

Call it from another service

Consume the service from your own backend, in any language.

Next

Create an application

On this page