Render Document

Render Document

The Render Document step is used to generate a document using a specified template and provided options. This step allows users to create structured documents dynamically based on predefined templates, input variables, and additional metadata. The generated document can be retrieved as text or a downloadable PDF.

Options

name

The name of the user for whom the document is being generated.

email

The email address associated with the document recipient.

phone_number

The phone number associated with the document recipient.

document_template_id

The unique identifier of the document template to be used for generating the document.

content_variables

A dictionary of key-value pairs containing dynamic content for the document.

shrink_file_size

A boolean value indicating whether to reduce the file size of the generated document.

Output

generated_document_id

The unique identifier of the generated document.

pdf_url

The URL to download the generated document in PDF format.

text

The raw text of the generated documents.

Properties

type

Document generation

needs conversation

false

uses content template

true

uses options template

true

customizable output schema

false