Quickstart: Generating your first document

Create a reusable HTML template, fill in two values, and generate a PDF saved in Inkit. This walkthrough uses Studio, a Fillable Form workflow, and Files.

Before you start

You need access to create templates and workflows and to launch workflows. Workflow creation requires an Enterprise plan. If New → Workflow is unavailable, ask your organization administrator for access, or use the API generation guide with an authorized API key.

The screenshots show the current application running locally with fictional example data.

Creating a simple HTML template

  1. Save the following HTML as project-summary.html. The two values inside double braces are merge fields: project_name and customer_name.
<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8">
    <title>Project summary</title>
    <style>
      body { font-family: Arial, sans-serif; padding: 48px; color: #14233a; }
      h1 { font-size: 28px; }
      p { font-size: 16px; line-height: 1.6; }
      .note { margin-top: 48px; color: #526173; }
    </style>
  </head>
  <body>
    <h1>Project summary</h1>
    <p>Project: {{project_name}}</p>
    <p>Prepared for: {{customer_name}}</p>
    <p>This sample demonstrates merging project information into a reusable document template.</p>
    <p class="note">Fictional example for Inkit documentation.</p>
  </body>
</html>
  1. Open Studio. Open the menu beside New and choose Template.
  2. In Create New Template, choose your HTML file, set Title to Project summary, and click Continue.
Current Create New Template upload dialog
  1. In the HTML editor, click Save to save the template.
  2. Click Preview. Enter Documentation refresh for project_name and Acme Example for customer_name, then click Preview in the side panel.
  3. Check that the rendered document contains those values. Close the preview and return to Studio.
HTML template preview with the quickstart merge values
📘

Preview checks the template's output. Use the workflow below to generate a document saved in Files.

Generating a document using the Inkit web app

Create the workflow

  1. In Studio, open the menu beside New and choose Workflow.
  2. Choose Fillable Form, then click Select.
  3. In Workflow Details, enter Project summary workflow, leave Active enabled, and click Next.
  4. In Packet Builder, select Project summary, click Add to Workflow, and confirm it appears in Selected Documents. Click Next.
Project summary template added to the workflow packet
  1. In Destinations, keep the automatically included Inkit Storage destination. This example does not need an additional destination. Click Next.
  2. In Mapping, set File Name to Project summary and choose Personal under Location. Leave expiration disabled for this example, then click Next.
  3. In Forms, review the customer_name and project_name fields. Leave them editable so you can enter values each time you run the workflow. Click Finish to create the workflow.
Form Builder with the two quickstart fields

Fill out the form

  1. Find Project summary workflow in Studio and click Fill Out in its row.
  2. Enter these values:
FieldValue
customer_nameAcme Example
project_nameDocumentation refresh
  1. Click Submit Form and wait for the submission to finish.
Current Fill Out form ready to submit

Open your generated PDF

  1. Open Files and select Personal, matching the location configured in the workflow.
  2. Find Project summary.pdf. Processing can take a moment; refresh the list if the new file is not visible yet.
  3. Click the file's name to open it. Check that it contains Project: Documentation refresh and Prepared for: Acme Example.
  4. Use the download button at the top of the viewer to download the PDF.
Saved quickstart PDF opened in the current document viewer

You now have a saved template, a reusable workflow, and a generated PDF. Use Fill Out again with different values to create another document. Each submission can create another output, so check the first result before resubmitting.

Generating a document using the Inkit API

To generate directly from the same saved template, follow Generate and download a document. Use your template ID and these merge parameters:

{
  "project_name": "Documentation refresh",
  "customer_name": "Acme Example"
}

The current generation endpoint is POST /api/v1/generate on your Inkit deployment. The API guide covers authentication, the complete request, processing status, and downloading the result. Direct template generation does not require the Fillable Form workflow created above.


Did this page help you?