Do I need the npm package?

No. If the npm package isn't available, render directly with fetch. See Render with fetch.

How do I authenticate?

With an API key in the x-api-key header. The key belongs on the server only. See Prerequisites.

Can I render straight from the browser?

Not with your API key: every key has full API access, so shipping one to the browser exposes it. Call the service from your own backend and hand the resulting URL to the frontend. See Call it from another service.

Where do I get the Application ID and Template ID?

From the Tuix dashboard: the Applications table shows the Application ID, an application's templates table shows the Template ID. Both columns have a copy icon.

How do I pass variables to the template?

Through data, a plain JSON object per document. In the template the keys are addressed by name, e.g. {{ customerName }}. See Template syntax.

Can I render several PDFs in one request?

Yes, payloads takes one entry per document, and they may use different templates of the same application. The batch is all-or-nothing.

A URL per generated document, plus the id you sent, so you can match results to your own entities. See Request reference.

Rendering answers 500, what now?

Most often the template has invalid syntax, e.g. a variable written with a leading dot ({{ .name }} instead of {{ name }}). Check the template in the editor preview. See Template syntax.

Why do I get 403 Forbidden?

The API key is unknown or was deleted. 401 instead means no key was sent at all. See API Keys.

Basics

Getting Started Create an application Create a template Prerequisites API Keys

Rendering PDFs

Install the client Render with fetch Call it from another service Download a PDF

Reference

Request reference Template syntax FAQ

FAQ

Common questions about the Tuix PDF Service.

FAQ