Generate Document from Template
curl --request POST \
--url https://api.luminpdf.com/v1/templates/{template_id}/generate-document \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"tags": {
"Client.Name": "Acme Corp",
"Effective.Date": "2025-08-01"
},
"fields": {
"CustomerName": "John Doe",
"AgreeToTerms": true
},
"variables": {
"Company.Name": "ACME Corp",
"Document.Name": "NDA Document"
},
"collections": {
"Opportunity.LineItems": [
{
"Product.Name": "Annual enterprise license",
"Product.Quantity": "1",
"Product.UnitPrice": "$1,000.00",
"Product.Total": "$1,000.00"
},
{
"Product.Name": "Premium support package",
"Product.Quantity": "1",
"Product.UnitPrice": "$500.00",
"Product.Total": "$500.00"
}
]
},
"document_name": "My Contract"
}
'import requests
url = "https://api.luminpdf.com/v1/templates/{template_id}/generate-document"
payload = {
"tags": {
"Client.Name": "Acme Corp",
"Effective.Date": "2025-08-01"
},
"fields": {
"CustomerName": "John Doe",
"AgreeToTerms": True
},
"variables": {
"Company.Name": "ACME Corp",
"Document.Name": "NDA Document"
},
"collections": { "Opportunity.LineItems": [
{
"Product.Name": "Annual enterprise license",
"Product.Quantity": "1",
"Product.UnitPrice": "$1,000.00",
"Product.Total": "$1,000.00"
},
{
"Product.Name": "Premium support package",
"Product.Quantity": "1",
"Product.UnitPrice": "$500.00",
"Product.Total": "$500.00"
}
] },
"document_name": "My Contract"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
tags: {'Client.Name': 'Acme Corp', 'Effective.Date': '2025-08-01'},
fields: {CustomerName: 'John Doe', AgreeToTerms: true},
variables: {'Company.Name': 'ACME Corp', 'Document.Name': 'NDA Document'},
collections: {
'Opportunity.LineItems': [
{
'Product.Name': 'Annual enterprise license',
'Product.Quantity': '1',
'Product.UnitPrice': '$1,000.00',
'Product.Total': '$1,000.00'
},
{
'Product.Name': 'Premium support package',
'Product.Quantity': '1',
'Product.UnitPrice': '$500.00',
'Product.Total': '$500.00'
}
]
},
document_name: 'My Contract'
})
};
fetch('https://api.luminpdf.com/v1/templates/{template_id}/generate-document', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.luminpdf.com/v1/templates/{template_id}/generate-document",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'tags' => [
'Client.Name' => 'Acme Corp',
'Effective.Date' => '2025-08-01'
],
'fields' => [
'CustomerName' => 'John Doe',
'AgreeToTerms' => true
],
'variables' => [
'Company.Name' => 'ACME Corp',
'Document.Name' => 'NDA Document'
],
'collections' => [
'Opportunity.LineItems' => [
[
'Product.Name' => 'Annual enterprise license',
'Product.Quantity' => '1',
'Product.UnitPrice' => '$1,000.00',
'Product.Total' => '$1,000.00'
],
[
'Product.Name' => 'Premium support package',
'Product.Quantity' => '1',
'Product.UnitPrice' => '$500.00',
'Product.Total' => '$500.00'
]
]
],
'document_name' => 'My Contract'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.luminpdf.com/v1/templates/{template_id}/generate-document"
payload := strings.NewReader("{\n \"tags\": {\n \"Client.Name\": \"Acme Corp\",\n \"Effective.Date\": \"2025-08-01\"\n },\n \"fields\": {\n \"CustomerName\": \"John Doe\",\n \"AgreeToTerms\": true\n },\n \"variables\": {\n \"Company.Name\": \"ACME Corp\",\n \"Document.Name\": \"NDA Document\"\n },\n \"collections\": {\n \"Opportunity.LineItems\": [\n {\n \"Product.Name\": \"Annual enterprise license\",\n \"Product.Quantity\": \"1\",\n \"Product.UnitPrice\": \"$1,000.00\",\n \"Product.Total\": \"$1,000.00\"\n },\n {\n \"Product.Name\": \"Premium support package\",\n \"Product.Quantity\": \"1\",\n \"Product.UnitPrice\": \"$500.00\",\n \"Product.Total\": \"$500.00\"\n }\n ]\n },\n \"document_name\": \"My Contract\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.luminpdf.com/v1/templates/{template_id}/generate-document")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"tags\": {\n \"Client.Name\": \"Acme Corp\",\n \"Effective.Date\": \"2025-08-01\"\n },\n \"fields\": {\n \"CustomerName\": \"John Doe\",\n \"AgreeToTerms\": true\n },\n \"variables\": {\n \"Company.Name\": \"ACME Corp\",\n \"Document.Name\": \"NDA Document\"\n },\n \"collections\": {\n \"Opportunity.LineItems\": [\n {\n \"Product.Name\": \"Annual enterprise license\",\n \"Product.Quantity\": \"1\",\n \"Product.UnitPrice\": \"$1,000.00\",\n \"Product.Total\": \"$1,000.00\"\n },\n {\n \"Product.Name\": \"Premium support package\",\n \"Product.Quantity\": \"1\",\n \"Product.UnitPrice\": \"$500.00\",\n \"Product.Total\": \"$500.00\"\n }\n ]\n },\n \"document_name\": \"My Contract\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.luminpdf.com/v1/templates/{template_id}/generate-document")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"tags\": {\n \"Client.Name\": \"Acme Corp\",\n \"Effective.Date\": \"2025-08-01\"\n },\n \"fields\": {\n \"CustomerName\": \"John Doe\",\n \"AgreeToTerms\": true\n },\n \"variables\": {\n \"Company.Name\": \"ACME Corp\",\n \"Document.Name\": \"NDA Document\"\n },\n \"collections\": {\n \"Opportunity.LineItems\": [\n {\n \"Product.Name\": \"Annual enterprise license\",\n \"Product.Quantity\": \"1\",\n \"Product.UnitPrice\": \"$1,000.00\",\n \"Product.Total\": \"$1,000.00\"\n },\n {\n \"Product.Name\": \"Premium support package\",\n \"Product.Quantity\": \"1\",\n \"Product.UnitPrice\": \"$500.00\",\n \"Product.Total\": \"$500.00\"\n }\n ]\n },\n \"document_name\": \"My Contract\"\n}"
response = http.request(request)
puts response.read_body{
"document_name": "NDA_AcmeCorp",
"signed_url": "https://files.luminpdf.com/download/nda-acmecorp-abc123.pdf?expires=2025-08-24T10:45:00Z",
"expires_at": 1766726700
}{
"error_code": "<string>",
"error_message": "<string>"
}Templates
Generate Document from Template
Creates a downloadable document from an existing Lumin template.
POST
/
templates
/
{template_id}
/
generate-document
Generate Document from Template
curl --request POST \
--url https://api.luminpdf.com/v1/templates/{template_id}/generate-document \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"tags": {
"Client.Name": "Acme Corp",
"Effective.Date": "2025-08-01"
},
"fields": {
"CustomerName": "John Doe",
"AgreeToTerms": true
},
"variables": {
"Company.Name": "ACME Corp",
"Document.Name": "NDA Document"
},
"collections": {
"Opportunity.LineItems": [
{
"Product.Name": "Annual enterprise license",
"Product.Quantity": "1",
"Product.UnitPrice": "$1,000.00",
"Product.Total": "$1,000.00"
},
{
"Product.Name": "Premium support package",
"Product.Quantity": "1",
"Product.UnitPrice": "$500.00",
"Product.Total": "$500.00"
}
]
},
"document_name": "My Contract"
}
'import requests
url = "https://api.luminpdf.com/v1/templates/{template_id}/generate-document"
payload = {
"tags": {
"Client.Name": "Acme Corp",
"Effective.Date": "2025-08-01"
},
"fields": {
"CustomerName": "John Doe",
"AgreeToTerms": True
},
"variables": {
"Company.Name": "ACME Corp",
"Document.Name": "NDA Document"
},
"collections": { "Opportunity.LineItems": [
{
"Product.Name": "Annual enterprise license",
"Product.Quantity": "1",
"Product.UnitPrice": "$1,000.00",
"Product.Total": "$1,000.00"
},
{
"Product.Name": "Premium support package",
"Product.Quantity": "1",
"Product.UnitPrice": "$500.00",
"Product.Total": "$500.00"
}
] },
"document_name": "My Contract"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
tags: {'Client.Name': 'Acme Corp', 'Effective.Date': '2025-08-01'},
fields: {CustomerName: 'John Doe', AgreeToTerms: true},
variables: {'Company.Name': 'ACME Corp', 'Document.Name': 'NDA Document'},
collections: {
'Opportunity.LineItems': [
{
'Product.Name': 'Annual enterprise license',
'Product.Quantity': '1',
'Product.UnitPrice': '$1,000.00',
'Product.Total': '$1,000.00'
},
{
'Product.Name': 'Premium support package',
'Product.Quantity': '1',
'Product.UnitPrice': '$500.00',
'Product.Total': '$500.00'
}
]
},
document_name: 'My Contract'
})
};
fetch('https://api.luminpdf.com/v1/templates/{template_id}/generate-document', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.luminpdf.com/v1/templates/{template_id}/generate-document",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'tags' => [
'Client.Name' => 'Acme Corp',
'Effective.Date' => '2025-08-01'
],
'fields' => [
'CustomerName' => 'John Doe',
'AgreeToTerms' => true
],
'variables' => [
'Company.Name' => 'ACME Corp',
'Document.Name' => 'NDA Document'
],
'collections' => [
'Opportunity.LineItems' => [
[
'Product.Name' => 'Annual enterprise license',
'Product.Quantity' => '1',
'Product.UnitPrice' => '$1,000.00',
'Product.Total' => '$1,000.00'
],
[
'Product.Name' => 'Premium support package',
'Product.Quantity' => '1',
'Product.UnitPrice' => '$500.00',
'Product.Total' => '$500.00'
]
]
],
'document_name' => 'My Contract'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.luminpdf.com/v1/templates/{template_id}/generate-document"
payload := strings.NewReader("{\n \"tags\": {\n \"Client.Name\": \"Acme Corp\",\n \"Effective.Date\": \"2025-08-01\"\n },\n \"fields\": {\n \"CustomerName\": \"John Doe\",\n \"AgreeToTerms\": true\n },\n \"variables\": {\n \"Company.Name\": \"ACME Corp\",\n \"Document.Name\": \"NDA Document\"\n },\n \"collections\": {\n \"Opportunity.LineItems\": [\n {\n \"Product.Name\": \"Annual enterprise license\",\n \"Product.Quantity\": \"1\",\n \"Product.UnitPrice\": \"$1,000.00\",\n \"Product.Total\": \"$1,000.00\"\n },\n {\n \"Product.Name\": \"Premium support package\",\n \"Product.Quantity\": \"1\",\n \"Product.UnitPrice\": \"$500.00\",\n \"Product.Total\": \"$500.00\"\n }\n ]\n },\n \"document_name\": \"My Contract\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.luminpdf.com/v1/templates/{template_id}/generate-document")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"tags\": {\n \"Client.Name\": \"Acme Corp\",\n \"Effective.Date\": \"2025-08-01\"\n },\n \"fields\": {\n \"CustomerName\": \"John Doe\",\n \"AgreeToTerms\": true\n },\n \"variables\": {\n \"Company.Name\": \"ACME Corp\",\n \"Document.Name\": \"NDA Document\"\n },\n \"collections\": {\n \"Opportunity.LineItems\": [\n {\n \"Product.Name\": \"Annual enterprise license\",\n \"Product.Quantity\": \"1\",\n \"Product.UnitPrice\": \"$1,000.00\",\n \"Product.Total\": \"$1,000.00\"\n },\n {\n \"Product.Name\": \"Premium support package\",\n \"Product.Quantity\": \"1\",\n \"Product.UnitPrice\": \"$500.00\",\n \"Product.Total\": \"$500.00\"\n }\n ]\n },\n \"document_name\": \"My Contract\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.luminpdf.com/v1/templates/{template_id}/generate-document")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"tags\": {\n \"Client.Name\": \"Acme Corp\",\n \"Effective.Date\": \"2025-08-01\"\n },\n \"fields\": {\n \"CustomerName\": \"John Doe\",\n \"AgreeToTerms\": true\n },\n \"variables\": {\n \"Company.Name\": \"ACME Corp\",\n \"Document.Name\": \"NDA Document\"\n },\n \"collections\": {\n \"Opportunity.LineItems\": [\n {\n \"Product.Name\": \"Annual enterprise license\",\n \"Product.Quantity\": \"1\",\n \"Product.UnitPrice\": \"$1,000.00\",\n \"Product.Total\": \"$1,000.00\"\n },\n {\n \"Product.Name\": \"Premium support package\",\n \"Product.Quantity\": \"1\",\n \"Product.UnitPrice\": \"$500.00\",\n \"Product.Total\": \"$500.00\"\n }\n ]\n },\n \"document_name\": \"My Contract\"\n}"
response = http.request(request)
puts response.read_body{
"document_name": "NDA_AcmeCorp",
"signed_url": "https://files.luminpdf.com/download/nda-acmecorp-abc123.pdf?expires=2025-08-24T10:45:00Z",
"expires_at": 1766726700
}{
"error_code": "<string>",
"error_message": "<string>"
}Required scopes (OAuth 2.0)
Required scopes (OAuth 2.0)
This endpoint requires the following scope:
templatesAuthorizations
ApiKeyBearerAuth
Provide your API key in the X-API-Key header, e.g., X-API-Key: YOUR_API_KEY.
Path Parameters
ID of the template to generate document from.
Body
application/json
Key–value pairs for Merge Tags defined in the Sign template. Keys must match tag names. Values replace the corresponding tags and are rendered as plain text in the generated document.
Key–value pairs for Form Fields defined in the template. Keys must match field names. Values prefill the corresponding fields in the generated document.
Key–value pairs for Variables defined in the AgreementGen template. Keys must match variable names. Values prefill the corresponding variables and are rendered as plain text in the generated document.
Map of collection name → array of record objects used to expand table-scoped row-loop markers in the template.
- Each key must match a collection name returned by Get Template Details under
collections[].name. - Each value is an ordered array of flat record objects; each record is a key–value map where keys match the collection's variable names and values are strings.
- Records are rendered in array order.
- Maximum 100 items per collection, and up to 50 collections per request.
Applies to AgreementGen templates only. Ignored silently when the template type is not lumin.
Optional name for the generated document. If omitted, the document name defaults to the template's name.
Response
Returns the generated document.
Name of the generated document (from input or default).
Signed HTTPS URL to download the generated document. Expires in 30 minutes.
Unix epoch timestamp (in seconds) indicating when signed_url will no longer work.