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

Integration developers: If you're interested in building an integration for DocsAutomator, please reach out to support.

Authorization

DocsAutomator uses API keys for authentication. The API key is passed like so:

Authorization: Bearer API_KEY

Error 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:

401 — Incorrect API KEY

Please make sure you're passing the correct API key. Otherwise, you'll receive the following error:

{
  "message": 'Incorrect / missing API key'
}

401 — No Google Refresh Token

400 — No Automation ID

404 — Automation ID not found

404 — No Template Set

402 — Document Limit Reached

404 — Automation not active

Endpoints

Create a new document

post

This endpoint triggers document creation as a POST request. Choose ONE of the following patterns based on your data source:

Pattern 1: API Data Source - Pass docId + data object with your placeholder values

Pattern 2: Airtable - Pass docId + recId (record ID) to fetch data from Airtable

Pattern 3: Google Sheets - Pass docId + rowId (row number) to fetch data from a specific row

Pattern 4: ClickUp - Pass docId + taskId to fetch data from a ClickUp task

Pattern 5: One-off Document - Pass docTemplateLink + data to generate a document without a saved automation

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequired

Content type header

Example: application/json

AuthorizationstringRequired

Authorization header with Bearer token

Example: Bearer {apiKey}

Body

application/json

or

or

or

or

Responses

200

Document created successfully

application/json

202

Document creation queued (async mode)

application/json

post

/createDocument

HTTPcURLJavaScriptPython

POST /createDocument HTTP/1.1
Host: api.docsautomator.co
Authorization: Bearer {apiKey}
Content-Type: application/json
Accept: */*
Content-Length: 336

{
  "docId": "your-automation-id",
  "documentName": "Invoice #1234",
  "data": {
    "customer_name": "Acme Corp",
    "invoice_date": "2024-01-15",
    "line_items_1": [
      {
        "product_name": "Consulting Services",
        "quantity": "5",
        "unit_price": "150.00",
        "line_total": "750.00"
      },
      {
        "product_name": "Software License",
        "quantity": "1",
        "unit_price": "299.00",
        "line_total": "299.00"
      }
    ]
  }
}

API Data SourceAirtableGoogle SheetsClickUpOne-off DocumentNested Line Items (Hierarchical Data)

{
  "message": "success",
  "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",
  "savePdfGoogleDriveFileId": "1AbCdEfGhIjKlMnOpQrStUvWxYz",
  "savePdfGoogleDriveUrl": "https://drive.google.com/file/d/1AbCdEfGhIjKlMnOpQrStUvWxYz/view",
  "signingSessionId": "text",
  "signingStatus": "created",
  "signingDeliveryMethod": "email",
  "signingLinks": [
    {
      "signerIndex": 1,
      "email": "text",
      "name": "text",
      "signingUrl": "text",
      "status": "text"
    }
  ]
}

Get workspace automations

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful response

application/json

401

Unauthorized

404

User not found

500

Internal server error

get

/automations

HTTPcURLJavaScriptPython

GET /automations HTTP/1.1
Host: api.docsautomator.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "automations": [
    {
      "dataSource": {
        "airtableLinkedFields": [
          "text"
        ],
        "name": "text",
        "airtableBaseId": "text",
        "airtableTableId": "text"
      },
      "imageOptions": {
        "quality": "text",
        "maxWidth": 1
      },
      "options": {
        "lineDeletions": [
          "text"
        ]
      },
      "title": "text",
      "dateCreated": "2026-02-05T01:03:28.919Z",
      "locale": "text",
      "isActive": true,
      "formatNumbersWithLocale": true,
      "pdfExpiration": "2026-02-05T01:03:28.919Z",
      "_id": "text",
      "docTemplateLink": "text",
      "newDocumentNameField": "text",
      "attachmentField": "text",
      "lastPreviewPdf": "text",
      "dataSourceName": "text"
    }
  ]
}

Update an automation

put

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

docIdstringRequired

The ID of the automation document

Body

application/json

objectOptional

Responses

200

Automation updated successfully

application/json

400

Bad request

401

Unauthorized

404

Document not found

500

Internal server error

put

/updateAutomation

HTTPcURLJavaScriptPython

PUT /updateAutomation?docId=text HTTP/1.1
Host: api.docsautomator.co
Authorization: Bearer YOUR_SECRET_TOKEN
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": "2026-02-05T01:03:28.919Z",
    "imageOptions": {
      "quality": "text",
      "maxWidth": 1
    },
    "options": {
      "lineDeletions": [
        "text"
      ]
    }
  }
}

Delete an automation

delete

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

docIdstringRequired

The ID of the automation document

Responses

200

Automation deleted successfully

application/json

401

Unauthorized

404

Document or user not found

500

Internal server error

delete

/deleteAutomation

HTTPcURLJavaScriptPython

DELETE /deleteAutomation?docId=text HTTP/1.1
Host: api.docsautomator.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "message": "text",
  "user": {}
}

List placeholders in automation

get

This endpoint lists placeholders in an automation. The response includes all placeholders for main document and line items.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

automationIdstringRequired

The ID of the automation

Responses

200

Placeholders listed successfully

application/json

401

Unauthorized

404

Automation or user not found

500

Internal server error

get

/listPlaceholdersV2

HTTPcURLJavaScriptPython

GET /listPlaceholdersV2?automationId=text HTTP/1.1
Host: api.docsautomator.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "placeholders": {
    "main": [
      "text"
    ],
    "line_items_1": [],
    "line_items_2": []
  }
}

Duplicate an automation

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

automationIdstringRequired

The ID of the automation to duplicate

Responses

200

Automation duplicated successfully

application/json

401

Unauthorized

404

Automation or user not found

500

Internal server error

post

/duplicateAutomation

HTTPcURLJavaScriptPython

POST /duplicateAutomation?automationId=text HTTP/1.1
Host: api.docsautomator.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "newAutomationId": "text"
}

Duplicate a Google Doc template

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

automationIdstringRequired

The ID of the automation containing the template to duplicate

newTemplateNamestringOptional

The name for the new template

Responses

200

Google Doc template duplicated successfully

application/json

400

Bad request

401

Unauthorized

404

Automation or user not found

500

Internal server error

post

/duplicateGoogleDocTemplate

HTTPcURLJavaScriptPython

POST /duplicateGoogleDocTemplate?automationId=text HTTP/1.1
Host: api.docsautomator.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "message": "text",
  "newTemplateId": "text",
  "url": "text"
}

Create a new automation

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

titlestringRequired

dataSourceNamestringRequired

docTemplateLinkstring · nullableOptional

Responses

201

Automation created successfully

application/json

400

Bad request

401

Unauthorized

500

Internal server error

post

/createAutomation

HTTPcURLJavaScriptPython

POST /createAutomation HTTP/1.1
Host: api.docsautomator.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "title": "text",
  "dataSourceName": "text",
  "docTemplateLink": "text"
}

{
  "message": "text",
  "newAutomation": {
    "title": "text",
    "dateCreated": "2026-02-05T01:03:28.919Z",
    "docTemplateLink": "text",
    "dataSource": {
      "name": "text"
    },
    "_id": "text"
  }
}