With DocuGenerate, you can create PDF and Word documents directly from your Python application. This guide shows how to call each API method from Python 3.9 or later. For the full list of parameters and responses, see the API Reference.
1. Authentication
2. Create template
3. List templates
4. Get template
5. Update template
6. Delete template
7. Generate document
8. List documents
9. Get document
10. Update document
11. Delete document
Every request is authenticated by sending your API Key in the Authorization header. Store the key in an environment variable rather than hardcoding it in your source code, and install the requests library if it’s not already available:
export DOCUGENERATE_API_KEY="YOUR-API-KEY"
pip install requests
All the examples below share these imports and constants. Since requests doesn’t raise an exception on HTTP error statuses, each example checks response.ok before reading the response:
import os
import requests
API_URL = 'https://api.docugenerate.com/v1'
API_KEY = os.environ['DOCUGENERATE_API_KEY']
If your account stores data in another region, replace the base URL with the matching regional endpoint, for example https://api.eu.docugenerate.com/v1.
To create a template, upload the template file with a POST /template request. This endpoint requires the multipart/form-data content type, which requests sets automatically, along with the multipart boundary, when the file is passed in files:
with open('Business Letter.docx', 'rb') as file:
response = requests.post(
f'{API_URL}/template',
headers={
'Authorization': API_KEY,
'Accept': 'application/json'
},
files={'file': file},
data={'name': 'Business Letter'}
)
if not response.ok:
raise Exception(f'DocuGenerate API error {response.status_code}: {response.text}')
template = response.json()
print(template['id'])
Don’t set the Content-Type header yourself, otherwise the boundary is missing and the request fails. The response contains the new template, including the tags detected automatically in the file:
{
"enhanced_syntax": false,
"versioning_enabled": false,
"folder": [],
"tags": {
"valid": [
"Date",
"Name",
"Job Title",
"Company Name",
"Street Address",
"City",
"State",
"Zip Code",
"Email",
"Phone"
],
"invalid": []
},
"created": 1791055374301,
"updated": 1791055374301,
"name": "Business Letter",
"delimiters": {
"left": "[",
"right": "]"
},
"filename": "Business Letter.docx",
"format": ".docx",
"region": "eu",
"page_count": 1,
"image_uri": "https://firebasestorage.googleapis.com/v0/b/storage.eu.docugenerate.com/o/templates%2FuVE30i1427KQsYcED0bl%2FBusiness%20Letter.png?alt=media&token=0ce64a4b-495a-426b-8783-42b479f7ae38",
"preview_uri": "https://firebasestorage.googleapis.com/v0/b/storage.eu.docugenerate.com/o/templates%2FuVE30i1427KQsYcED0bl%2FBusiness%20Letter.pdf?alt=media&token=0b3939c7-824e-4979-9aca-ca4a87175cbf",
"template_uri": "https://firebasestorage.googleapis.com/v0/b/storage.eu.docugenerate.com/o/templates%2FuVE30i1427KQsYcED0bl%2FBusiness%20Letter.docx?alt=media&token=d37a4458-3620-48db-94b8-6ac46f0442ab",
"id": "uVE30i1427KQsYcED0bl"
}
Keep the template id, as you’ll need it to generate documents. The following optional parameters can also be passed in data:
delimiters: The delimiters used to detect the tags, sent as a JSON string, e.g. json.dumps({'left': '[', 'right': ']'}). By default, they’re determined automatically.region: Where the template and its generated documents are stored, either us, eu, uk or au. By default, the account’s default region is used.enhanced_syntax: Set to 'true' to use nested properties and logical or mathematical operators in the tags.versioning_enabled: Set to 'true' to keep previous versions of the file when uploading a new one, if your plan allows it.folder: The folder of the template, from root to leaf. Missing folders are created automatically.To place the template in a folder, pass a list with one folder name for each level of the path, which requests sends as one folder field per level. For example, to place it in the Letters > Business folder:
data={
'name': 'Business Letter',
'folder': ['Letters', 'Business']
}
A GET /template request returns all the templates in your account:
response = requests.get(
f'{API_URL}/template',
headers={
'Authorization': API_KEY,
'Accept': 'application/json'
}
)
if not response.ok:
raise Exception(f'DocuGenerate API error {response.status_code}: {response.text}')
templates = response.json()
for template in templates:
print(template['id'], template['name'])
To only list the templates of a folder, repeat the folder query parameter for each level of the path. Passing a list in params does this automatically. For example, to list the templates in the Letters > Business folder:
response = requests.get(
f'{API_URL}/template',
headers={
'Authorization': API_KEY,
'Accept': 'application/json'
},
params={'folder': ['Letters', 'Business']}
)
if not response.ok:
raise Exception(f'DocuGenerate API error {response.status_code}: {response.text}')
Only the templates placed directly in that folder are returned. Templates in its subfolders aren’t included. To learn more, see how to organize templates in folders with the API.
To retrieve a single template, call GET /template/{id} with its ID:
template_id = 'bet2oQirk0pSd9ctH9Qu'
response = requests.get(
f'{API_URL}/template/{template_id}',
headers={
'Authorization': API_KEY,
'Accept': 'application/json'
}
)
if not response.ok:
raise Exception(f'DocuGenerate API error {response.status_code}: {response.text}')
template = response.json()
print(template['tags']['valid'])
This is useful, for example, to check which merge tags the template expects before generating documents.
A PUT /template/{id} request updates a template. All the parameters are optional, so only send the ones you want to change. For example, to upload a new version of the file and rename the template:
template_id = 'bet2oQirk0pSd9ctH9Qu'
with open('Business Letter v2.docx', 'rb') as file:
response = requests.put(
f'{API_URL}/template/{template_id}',
headers={
'Authorization': API_KEY,
'Accept': 'application/json'
},
files={'file': file},
data={'name': 'Business Letter v2'}
)
if not response.ok:
raise Exception(f'DocuGenerate API error {response.status_code}: {response.text}')
template = response.json()
As when creating a template, the body must be multipart/form-data, which is set automatically, along with the multipart boundary, when the file is passed in files. Besides file and name, the following optional parameters can be passed in data:
delimiters: The new delimiters, sent as a JSON string. If provided, the template is parsed again to detect the merge tags based on the new delimiters. When a new file is uploaded without delimiters, the current delimiters are used.region: Moves the template to another region, either us, eu, uk or au. Documents generated afterwards are stored in the new region, while existing documents stay in their current region.folder: Moves the template to another folder, with one folder name for each level of the path. Send '[]' to move the template out of any folder.enhanced_syntax: Set to 'true' or 'false' to enable or disable the enhanced syntax.versioning_enabled: Set to 'true' or 'false' to enable or disable the version history, if your plan allows it.To delete a template, send a DELETE /template/{id} request. The API responds with a 204 No Content status on success:
template_id = 'bet2oQirk0pSd9ctH9Qu'
response = requests.delete(
f'{API_URL}/template/{template_id}',
headers={
'Authorization': API_KEY,
'Accept': 'application/json'
}
)
if not response.ok:
raise Exception(f'DocuGenerate API error {response.status_code}: {response.text}')
You generate documents with a POST /document request, passing the template_id and the data used to replace the merge tags. When the body is passed in json, requests sets the Content-Type header to application/json automatically:
response = requests.post(
f'{API_URL}/document',
headers={
'Authorization': API_KEY,
'Accept': 'application/json'
},
json={
'template_id': 'bet2oQirk0pSd9ctH9Qu',
'data': {
'Date': 'October 4, 2026',
'Name': 'Emily Carter',
'Job Title': 'Operations Manager',
'Company Name': 'Harbor Point Consulting',
'Street Address': '118 West Street',
'City': 'Annapolis',
'State': 'Maryland',
'Zip Code': '21405',
'Email': 'emily.carter@example.com',
'Phone': '(410) 555-0142'
},
'output_format': '.pdf'
}
)
if not response.ok:
raise Exception(f'DocuGenerate API error {response.status_code}: {response.text}')
document = response.json()
print(document['document_uri'])
The response contains the document’s properties:
{
"created": 1791125416372,
"template_id": "bet2oQirk0pSd9ctH9Qu",
"name": "Business Letter",
"format": ".pdf",
"data_length": 1,
"filename": "Business Letter.pdf",
"document_uri": "https://firebasestorage.googleapis.com/v0/b/storage.us.docugenerate.com/o/documents%2FiESelthRt4uaYQRTemrL%2FBusiness%20Letter.pdf?alt=media&token=c4b259ec-249b-4b35-a62f-6a8dc0da75f3",
"id": "iESelthRt4uaYQRTemrL"
}
The output_format can be .docx (the default), .pdf, .doc, .odt, .txt, .html, .png or a PDF/A version. You can also merge PDF files at the end of the generated document with merge_with, or add attachments with attach.
Downloading the file
The document_uri points to the generated file, which you can download and save to disk:
file = requests.get(document['document_uri'])
if not file.ok:
raise Exception(f'Download failed with status {file.status_code}')
with open(document['filename'], 'wb') as output:
output.write(file.content)
Receiving the file directly
If you don’t want the document stored in the cloud, set the Accept header to application/octet-stream. The API then responds with the binary file instead of JSON:
response = requests.post(
f'{API_URL}/document',
headers={
'Authorization': API_KEY,
'Accept': 'application/octet-stream'
},
json={
'template_id': 'bet2oQirk0pSd9ctH9Qu',
'data': {
'Date': 'October 4, 2026',
'Name': 'Emily Carter',
'Job Title': 'Operations Manager',
'Company Name': 'Harbor Point Consulting',
'Street Address': '118 West Street',
'City': 'Annapolis',
'State': 'Maryland',
'Zip Code': '21405',
'Email': 'emily.carter@example.com',
'Phone': '(410) 555-0142'
},
'output_format': '.pdf'
}
)
if not response.ok:
raise Exception(f'DocuGenerate API error {response.status_code}: {response.text}')
with open('Business Letter.pdf', 'wb') as output:
output.write(response.content)
print(response.headers['X-Document-Id'])
Batch document generation
To generate several documents in one request, pass a list of dictionaries as data. A document is generated for each dictionary:
response = requests.post(
f'{API_URL}/document',
headers={
'Authorization': API_KEY,
'Accept': 'application/json'
},
json={
'template_id': 'bet2oQirk0pSd9ctH9Qu',
'data': [
{'Date': 'October 4, 2026', 'Name': 'Emily Carter', 'Job Title': 'Operations Manager', 'Company Name': 'Harbor Point Consulting', 'Street Address': '118 West Street', 'City': 'Annapolis', 'State': 'Maryland', 'Zip Code': '21405', 'Email': 'emily.carter@example.com', 'Phone': '(410) 555-0142'},
{'Date': 'October 4, 2026', 'Name': 'Daniel Brooks', 'Job Title': 'Logistics Coordinator', 'Company Name': 'Northfield Logistics', 'Street Address': '2400 South Lamar Boulevard', 'City': 'Austin', 'State': 'Texas', 'Zip Code': '78704', 'Email': 'daniel.brooks@example.com', 'Phone': '(512) 555-0187'}
],
'output_format': '.pdf',
'single_file': True,
'page_break': True
}
)
if not response.ok:
raise Exception(f'DocuGenerate API error {response.status_code}: {response.text}')
document = response.json()
By default, all the documents are combined in a single file, with a page break after each one. Set page_break to False to remove the page breaks.
When single_file is False, a file is generated per data object and all the files are grouped in a .zip archive. Use the name parameter to name the archive, and output_name with merge tags to give each file a dynamic name, such as Letter for [Name]:
json={
'template_id': 'bet2oQirk0pSd9ctH9Qu',
'data': [...],
'output_format': '.pdf',
'single_file': False,
'name': 'Business Letters',
'output_name': 'Letter for [Name]'
}
This generates a Business Letters.zip archive containing Letter for Emily Carter.pdf and Letter for Daniel Brooks.pdf. The merge tags in output_name must use the same delimiters as the template.
Using a data file
To generate documents in bulk from an Excel or CSV file, send the file in a multipart/form-data request. A document is generated for each row of the spreadsheet. If the file has several sheets, specify the sheet parameter to choose which one to use.
with open('Data.xlsx', 'rb') as file:
response = requests.post(
f'{API_URL}/document',
headers={
'Authorization': API_KEY,
'Accept': 'application/json'
},
files={'file': file},
data={
'template_id': 'bet2oQirk0pSd9ctH9Qu',
'output_format': '.pdf'
}
)
if not response.ok:
raise Exception(f'DocuGenerate API error {response.status_code}: {response.text}')
Using a data file is another form of batch generation, so the same parameters apply for combining generated documents in a single file or grouping them in a .zip archive with a custom name for each file.
A GET /document request returns the documents generated from a template, whose ID is passed in the template_id query parameter:
response = requests.get(
f'{API_URL}/document',
headers={
'Authorization': API_KEY,
'Accept': 'application/json'
},
params={'template_id': 'bet2oQirk0pSd9ctH9Qu'}
)
if not response.ok:
raise Exception(f'DocuGenerate API error {response.status_code}: {response.text}')
documents = response.json()
for document in documents:
print(document['id'], document['name'], document['document_uri'])
To retrieve a single document, call GET /document/{id} with its ID:
document_id = 'iESelthRt4uaYQRTemrL'
response = requests.get(
f'{API_URL}/document/{document_id}',
headers={
'Authorization': API_KEY,
'Accept': 'application/json'
}
)
if not response.ok:
raise Exception(f'DocuGenerate API error {response.status_code}: {response.text}')
document = response.json()
A PUT /document/{id} request renames a document, which is the only property that can be updated:
document_id = 'iESelthRt4uaYQRTemrL'
response = requests.put(
f'{API_URL}/document/{document_id}',
headers={
'Authorization': API_KEY,
'Accept': 'application/json'
},
json={'name': 'Letter for Emily Carter'}
)
if not response.ok:
raise Exception(f'DocuGenerate API error {response.status_code}: {response.text}')
document = response.json()
To delete a document, send a DELETE /document/{id} request. The API responds with a 204 No Content status on success:
document_id = 'iESelthRt4uaYQRTemrL'
response = requests.delete(
f'{API_URL}/document/{document_id}',
headers={
'Authorization': API_KEY,
'Accept': 'application/json'
}
)
if not response.ok:
raise Exception(f'DocuGenerate API error {response.status_code}: {response.text}')