DocsAutomator API
DocsAutomator offers a powerful REST API to create documents from anywhere and list, create, update and delete your DocsAutomator automations.
Intro
DocsAutomator's API allows you to generate documents programmatically from code. In addition, it offers endpoints to perform all CRUD actions on automations (create, read, update, delete) as well as listing placeholders of documents, copying a Google Doc tempate with code and more.
The API can be utilised to add a performant document creation solution into any software. If you have any questions, please reach out via chat or to [email protected].
If you haven't created a template yet, please start with the guide here: Google Doc Template Guide
Authorization
DocsAutomator uses API keys for authentication. The API key is passed like so:
Authorization: Bearer API_KEYError Responses
The API will send descriptive error responses for a variety of errors that can occur during document creation requests. Please find the most common errors listed below:
Please make sure you're passing the correct API key. Otherwise, you'll receive the following error:
{
"message": 'Incorrect / missing API key'
}Endpoints
This endpoint triggers document creation as a GET request. Successful requests don't receive a JSON response, just a status 200 (if you need the PDF or Google Doc URL as a response, please use the POST request below). This works for Airtable and ClickUp only and you will have to pass the Airtable Record ID or ClickUp Task ID when making a request. Error messages are returned as JSON.
API key for authentication
The ID of the document
Record ID for Airtable
Task ID for ClickUp
GET /createDocument HTTP/1.1
Host: api.docsautomator.co
Authorization: Bearer JWT
Accept: */*
Successful response
textThis endpoint triggers document creation as a POST request. For successes, you will receive a JSON response with the URL of the created PDF and optionally the url of the Google Doc (if enabled in your automation). Error messages are returned as JSON as explained above under 'Error Messages'.
Content type header
application/jsonAuthorization header with Bearer token
Bearer {apiKey}The ID of the document
The name of the generated document (data source API only)
Record ID for Airtable (Airtable only — data not required)
Task ID for ClickUp (ClickUp only — data not required)
POST /createDocument HTTP/1.1
Host: api.docsautomator.co
Authorization: Bearer {apiKey}
Content-Type: application/json
Accept: */*
Content-Length: 212
{
"docId": "text",
"documentName": "text",
"recId": "text",
"taskId": "text",
"data": {
"placeholderOne": "text",
"placeholderTwo": "text",
"line_items_$num": [
{
"lineItemPlaceholderOne": "text",
"lineItemPlaceholderTwo": "text"
}
]
}
}Document created successfully
{
"pdfUrl": "https://firebasestorage.googleapis.com/v0/b/docsautomator.appspot.com/o/1krzffnfKYAEO6gbOmvIHfnOqw6-OjaDSzemLkQb1yjM.pdf?alt=media&token=194fd896-e303-4e7c-8abd-d5718b91723c",
"googleDocUrl": "https://docs.google.com/document/d/1RQqb0JqkCHSp0WaJGuRAVt85C4yxxizV48kyhBPXoug/edit",
"savePdfGoogleDriveFolderId": "1RQqb0JqkCHSp0WaJGuRAVt85C4yxxizV48kyhBPXoug"
}GET /automations HTTP/1.1
Host: api.docsautomator.co
Authorization: Bearer JWT
Accept: */*
{
"automations": [
{
"dataSource": {
"airtableLinkedFields": [
"text"
],
"name": "text",
"airtableBaseId": "text",
"airtableTableId": "text"
},
"imageOptions": {
"quality": "text",
"maxWidth": 1
},
"options": {
"lineDeletions": [
"text"
]
},
"title": "text",
"dateCreated": "2025-06-27T04:45:15.609Z",
"locale": "text",
"isActive": true,
"formatNumbersWithLocale": true,
"pdfExpiration": "2025-06-27T04:45:15.609Z",
"_id": "text",
"docTemplateLink": "text",
"newDocumentNameField": "text",
"attachmentField": "text",
"lastPreviewPdf": "text",
"dataSourceName": "text"
}
]
}The ID of the automation document
PUT /updateAutomation HTTP/1.1
Host: api.docsautomator.co
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 2
{}{
"message": "text",
"updatedAutomation": {
"title": "text",
"docTemplateLink": "text",
"newDocumentNameField": "text",
"attachmentField": "text",
"locale": "text",
"dataSource": {
"name": "text",
"airtableBaseId": "text",
"airtableTableId": "text",
"airtableLinkedFields": [
"text"
]
},
"fields": {},
"saveGoogleDoc": true,
"overwriteAttachment": true,
"isActive": true,
"isPreview": true,
"lastPreviewPdf": "text",
"googleDocDestinationFolderUrl": "text",
"googleDocUrlField": "text",
"dateFormat": "text",
"formatNumbersWithLocale": true,
"pdfExpiration": "2025-06-27T04:45:15.609Z",
"imageOptions": {
"quality": "text",
"maxWidth": 1
},
"options": {
"lineDeletions": [
"text"
]
}
}
}The ID of the automation document
DELETE /deleteAutomation HTTP/1.1
Host: api.docsautomator.co
Authorization: Bearer JWT
Accept: */*
{
"message": "text",
"user": {}
}POST /createAutomation HTTP/1.1
Host: api.docsautomator.co
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 65
{
"title": "text",
"dataSourceName": "text",
"docTemplateLink": "text"
}{
"message": "text",
"newAutomation": {
"title": "text",
"dateCreated": "2025-06-27T04:45:15.609Z",
"docTemplateLink": "text",
"dataSource": {
"name": "text"
},
"_id": "text"
}
}This endpoint lists placeholders in an automation. The response includes all placeholders for main document and line items.
The ID of the automation
GET /listPlaceholdersV2 HTTP/1.1
Host: api.docsautomator.co
Authorization: Bearer JWT
Accept: */*
{
"placeholders": {
"main": [
"text"
],
"line_items_1": [],
"line_items_2": []
}
}The ID of the automation to duplicate
POST /duplicateAutomation HTTP/1.1
Host: api.docsautomator.co
Authorization: Bearer JWT
Accept: */*
{
"newAutomationId": "text"
}The ID of the automation containing the template to duplicate
The name for the new template
POST /duplicateGoogleDocTemplate HTTP/1.1
Host: api.docsautomator.co
Authorization: Bearer JWT
Accept: */*
{
"message": "text",
"newTemplateId": "text",
"url": "text"
}Last updated