Skip to main content
Qwilr API

API concepts

Qwilr has a few top level concepts that come together to allow programmatic page creation.


A Qwilr page is an easy-to-edit, rich webpage that can be shared externally. The Qwilr API helps you programmatically generate pages, listen to events on pages, and take actions on pages.


Templates are a page that you want to use as a starting point for new pages. With no special variables, a full page can be created from a template. To create a template, build a page, then you can convert it to a template.

A template formed out of a set of blocks

Templates are made up of blocks, just like any other page. A template doesn't go "live" and can't be shared with an unauthenticated user like a normal page.

While editing a template, you can place Tokens within your content. These Tokens are substituted for incoming values from the API.


A Block is a structured content area of your document.

A single splash block

Different types of blocks are used to break up a document into distinct sections. Text blocks, for example, allow for any length of rich text, including in-line images or videos. In contrast, a Splash block provides a full-bleed image, with text overlaid - as a distinct break between content sections.

Saved blocks are blocks with content / styles, intended to be used in future documents. Saved blocks are duplicated into a new document, and don't retain any connection with the block created. The new block can be edited and changed at-will.

Tokens (concept)

Tokens are placeholders for API variables in templates or saved blocks. In the Qwilr API code and API documentation, these are referred to as substitutions.

Tokens placed inline throughout a paragraph of text

For more detail on tokens, take a look at the .