DocsAutomator API

DocsAutomator offers a REST API to create documents programmatically, manage automations, and control e-signature workflows. Use it to add document generation into any software.

Getting Started

Get your API key

Find your API key at Workspace Settings > API Key.

Authenticate

Pass your API key as a bearer token in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Create a document

curl -X POST https://api.docsautomator.co/createDocument \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "docId": "YOUR_AUTOMATION_ID",
    "data": {
      "customer_name": "Acme Corp",
      "invoice_date": "2025-01-15",
      "total": "$1,500.00"
    }
  }'

Formatting Values

Send values raw (1234.5, 2026-06-30, true) and let DocsAutomator render them — open the gear icon next to a placeholder and pick a Format: currency, decimals, percent, date styles, or custom true/false labels. Conditions and calculations keep evaluating the raw value; formatting is display-only. See Format Values.

Placeholders & Descriptions

List an automation’s placeholders — and the description of each — before you build a createDocument payload:

curl "https://api.docsautomator.co/listPlaceholdersV2?automationId=YOUR_AUTOMATION_ID" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "placeholders": {
    "main": ["client_name", "fee", "start_date"],
    "line_items_1": ["description", "amount"]
  },
  "descriptions": {
    "client_name": "Full legal name of the customer, from the CRM contact record",
    "fee": "Total contract fee in EUR, numeric, no currency symbol"
  }
}

descriptions appears when per-placeholder descriptions are set. They tell an API client (or an AI agent) what data belongs in each placeholder. Set them in the app via the gear icon next to a mapping, or via the API:

curl -X PUT "https://api.docsautomator.co/updateAutomation?automationId=YOUR_AUTOMATION_ID" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"options": {"placeholderDescriptions": {"fee": "Total contract fee in EUR, numeric"}}}'

options.placeholderDescriptions replaces the whole map: read the current map first and send it back with your changes. Each description is a string of at most 2,000 characters.

Automations also carry their own description — what the automation is for and what data it needs. GET /automations and GET /automation return it; set it with {"description": "..."} on updateAutomation, or in the app under Automation Settings.

New automations start in test mode

Every automation you create with createAutomation, and every copy made with duplicateAutomation, starts in test mode (isPreview: true). Test documents are watermarked and free. When the automation is ready, switch it to live:

curl -X PUT "https://api.docsautomator.co/updateAutomation?automationId=YOUR_AUTOMATION_ID" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"isPreview": false}'

From then on, createDocument makes live documents that count in your plan. Going live needs a confirmed account email. You can also switch an automation to live in the app.

Full API Reference

For complete endpoint documentation with an interactive playground, see the API Reference tab.

Documents

Create documents, check job status, view queue stats

Automations

List, create, update, delete, and duplicate automations

Templates

List placeholders, duplicate templates

E-Signatures

Manage signing sessions, links, and audit trails

Need Help?

In-App Chat

Contact support via the in-app chat feature

Email Support

Reach out at support@docsautomator.co

Getting Started

Integrations

Features

Use Cases

Account & Billing

Resources

Getting Started

Formatting Values

Placeholders & Descriptions

New automations start in test mode

Full API Reference

Documents

Automations

Templates

E-Signatures

Need Help?

In-App Chat

Email Support

​Getting Started

​Formatting Values

​Placeholders & Descriptions

​New automations start in test mode

​Full API Reference

Documents

Automations

Templates

E-Signatures

​Need Help?

In-App Chat

Email Support

Getting Started

Formatting Values

Placeholders & Descriptions

New automations start in test mode

Full API Reference

Need Help?