Getting Started
This guide will walk you through uploading a template and generating your first document using our API.
Create an Account
To get started, sign up at docubloom.com/auth/signup . Once you’re logged in, go to Organization
> API Keys
to create an API key .
Create & Upload a Template
Create a .docx
file that contains placeholders like {name}
and {age}
. You can use Microsoft Word or any compatible editor to design your template.
You can download a sample template by clicking here.
Then upload your template by giving it a name and a unique templateKey
using one of the following methods:
- From the web app.
Go to
Manage Templates
and click onUpload Template
to select your.docx
file. - Or with an API call:
curl -X POST https://docubloom.com/api/template/upload \
-H "Authorization: Bearer YOUR_API_KEY" \
-H 'Content-Type: multipart/form-data' \
-F 'template=@/path/to/template.docx' \
-F 'templateName=My template' \
-F 'templateKey=my-template-key'
Generate a Document
Send your structured data (as JSON) and specify which template to use by its templateKey
. You can do it from the app under the Generate Document
page, or via the API:
curl -X POST https://docubloom.com/api/template/generate \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"templateKey": "my-template-key",
"output": "PDF",
"data": {
"name": "John",
"age": 30
}
}'
This will return your generated document in the specified format (PDF or DOCX) as a downloadable file.
✅ You’re Done!
You’ve now generated your first document using your own template and data. Explore our Template Variable Syntax for more complex placeholders, like loops, conditionals and images, to create dynamic documents.
You can also have a look at our API Reference for more capabilities, including listing templates, error handling, and more.