APIGuidesChangelogStatus
API
Sign InSign Up

Generate a document from a template

post
https://apps.inkit.com/api/v1/generate

Generate from an existing template. merge_parameters is required; use {} for a template without merge variables. Inkit Storage is added automatically. HTTP 201 returns identifiers before processing finishes. Poll the render and download after completion. Subscription, destination, and permission checks apply.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≤ 32
^tmpl_[a-zA-Z\d]+$

Template ID to render

string
length between 1 and 255

Document name

string
length between 1 and 65535

Document description

custom_data
object

Custom metadata

merge_parameters
object
required

Template merge parameters (key-value pairs)

destinations
object

Commercial destination configurations. Each destination requires its integration and account entitlement. Magic Link also requires its feature flag. Sepire is a legacy account-configured mail integration.

Responses

Updated 10 days ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 days ago

Did this page help you?