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 [e-mail].

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

Google's refresh token is valid for 60 days and might expire. Please re-authenticate in this case under settings in your DocsAutomator account.

{
  "message": "No refresh token found, please re-authenticate Google"
}

400 — No Automation ID

Please makes you're passing a valid automation id ("docId").

{
  "message": "Please add a valid automation id with key 'docId' to the request."
}

404 — Automation ID not found

Please makes you're passing a valid automation id ("docId") which is part of the authenticated user.

{
  "message": "Automation / template id does not exist or is not part of the account with the given API key. Please check in your DocsAutomator account."
}

404 — No Template Set

Please make sure to set a Google Doc template in your automation.

{
  "message": "No Google Docs template set for the given document id. Please set a template in your DocsAutomator account."
}

402 — Document Limit Reached

If you've reached your documents limit, you will receive the following:

{
  "message": "You have reached your documents limit. Please upgrade your plan: https://app.docsautomator.co/subscribe"
}

404 — Automation not active

Please make sure the automation is active when sending requests:

{
  "message": "Automation is not active. Please activate automation in your DocsAutomator account."
}

Endpoints

Create a document (Airtable and ClickUp only)

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.

GEThttps://api.docsautomator.co/createDocument

Query parameters

Response

200

Successful response

Body

text/html

string

Request

JavaScriptCurlPython

const response = await fetch('https://api.docsautomator.co/createDocument?apiKey=text&docId=text&recId=text&taskId=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

text

Create a new document

This 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'.

POSThttps://api.docsautomator.co/createDocument

Header parameters

Body

application/json

docId*string

The ID of the document

documentNamestring

The name of the generated document (data source API only)

recIdstring

Record ID for Airtable (Airtable only — data not required)

taskIdstring

Task ID for ClickUp (ClickUp only — data not required)

dataobject

Placeholders data for the template (data source API only)

Response

200

Document created successfully

Body

application/json

pdfUrlstring

Example: "https://firebasestorage.googleapis.com/v0/b/docsautomator.appspot.com/o/1krzffnfKYAEO6gbOmvIHfnOqw6-OjaDSzemLkQb1yjM.pdf?alt=media&token=194fd896-e303-4e7c-8abd-d5718b91723c"

googleDocUrlstring

Optional. Only present if the Google Doc is saved.

Example: "https://docs.google.com/document/d/1RQqb0JqkCHSp0WaJGuRAVt85C4yxxizV48kyhBPXoug/edit"

savePdfGoogleDriveFolderIdstring

Optional. Only present if the PDF is saved in a Google Drive folder.

Example: "1RQqb0JqkCHSp0WaJGuRAVt85C4yxxizV48kyhBPXoug"

Request

JavaScriptCurlPython

const response = await fetch('https://api.docsautomator.co/createDocument', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json",
      "Authorization": "Bearer {apiKey}"
    },
    body: JSON.stringify({
      "docId": "text"
    }),
});
const data = await response.json();

Response

200

{
  "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 user automations

GEThttps://api.docsautomator.co/automations

Response

200401404500

Successful response

Body

application/json

automationsarray of object

Request

JavaScriptCurlPython

const response = await fetch('https://api.docsautomator.co/automations', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "automations": [
    {
      "dataSource": {
        "airtableLinkedFields": [
          "text"
        ],
        "name": "text",
        "airtableBaseId": "text",
        "airtableTableId": "text"
      },
      "imageOptions": {
        "quality": "text"
      },
      "options": {
        "lineDeletions": [
          "text"
        ]
      },
      "title": "text",
      "dateCreated": "2024-10-08T21:38:32.654Z",
      "locale": "text",
      "isActive": false,
      "formatNumbersWithLocale": false,
      "pdfExpiration": "2024-10-08T21:38:32.654Z",
      "_id": "text",
      "docTemplateLink": "text",
      "newDocumentNameField": "text",
      "attachmentField": "text",
      "lastPreviewPdf": "text",
      "dataSourceName": "text"
    }
  ]
}

Update an automation

PUThttps://api.docsautomator.co/updateAutomation

Query parameters

Body

application/json

object

Response

200400401404500

Automation updated successfully

Body

application/json

messagestring

updatedAutomationobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.docsautomator.co/updateAutomation?docId=text', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Response

200

{
  "message": "text",
  "updatedAutomation": {
    "title": "text",
    "docTemplateLink": "text",
    "newDocumentNameField": "text",
    "attachmentField": "text",
    "locale": "text",
    "dataSource": {
      "name": "text",
      "airtableBaseId": "text",
      "airtableTableId": "text",
      "airtableLinkedFields": [
        "text"
      ]
    },
    "saveGoogleDoc": false,
    "overwriteAttachment": false,
    "isActive": false,
    "isPreview": false,
    "lastPreviewPdf": "text",
    "googleDocDestinationFolderUrl": "text",
    "googleDocUrlField": "text",
    "dateFormat": "text",
    "formatNumbersWithLocale": false,
    "pdfExpiration": "2024-10-08T21:38:32.654Z",
    "imageOptions": {
      "quality": "text"
    },
    "options": {
      "lineDeletions": [
        "text"
      ]
    }
  }
}

Delete an automation

DELETEhttps://api.docsautomator.co/deleteAutomation

Query parameters

Response

200401404500

Automation deleted successfully

Body

application/json

messagestring

usernullable object

Request

JavaScriptCurlPython

const response = await fetch('https://api.docsautomator.co/deleteAutomation?docId=text', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200

{
  "message": "text"
}

Create a new automation

POSThttps://api.docsautomator.co/createAutomation

Body

application/json

title*string

dataSourceName*string

docTemplateLinknullable string

Response

201400401500

Automation created successfully

Body

application/json

messagestring

newAutomationobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.docsautomator.co/createAutomation', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "title": "text",
      "dataSourceName": "text"
    }),
});
const data = await response.json();

Response

201

{
  "message": "text",
  "newAutomation": {
    "title": "text",
    "dateCreated": "2024-10-08T21:38:32.654Z",
    "docTemplateLink": "text",
    "dataSource": {
      "name": "text"
    },
    "_id": "text"
  }
}

List placeholders in automation

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

GEThttps://api.docsautomator.co/listPlaceholdersV2

Query parameters

Response

200401404500

Placeholders listed successfully

Body

application/json

placeholdersobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.docsautomator.co/listPlaceholdersV2?automationId=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Duplicate an automation

POSThttps://api.docsautomator.co/duplicateAutomation

Query parameters

Response

200401404500

Automation duplicated successfully

Body

application/json

newAutomationIdstring

Request

JavaScriptCurlPython

const response = await fetch('https://api.docsautomator.co/duplicateAutomation?automationId=text', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200

{
  "newAutomationId": "text"
}

Duplicate a Google Doc template

POSThttps://api.docsautomator.co/duplicateGoogleDocTemplate

Query parameters

Response

200400401404500

Google Doc template duplicated successfully

Body

application/json

messagestring

newTemplateIdstring

urlstring

Request

JavaScriptCurlPython

const response = await fetch('https://api.docsautomator.co/duplicateGoogleDocTemplate?automationId=text', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200

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