Automette docs
API Reference

Get a form's template connection

GET
/api/v1/forms/{id}/docgen

Authorization

ApiKeyAuth
AuthorizationBearer <token>

API key from Settings → API Keys.

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/forms/string/docgen"
{  "connected": true,  "template_id": "cm4tpl8e20001js04xq2v9k3m",  "template_name": "YouTube Thumbnail",  "engine": "canvas",  "field_map": {    "headline.text": {      "kind": "field",      "fieldKey": "video_title"    }  },  "output_formats": [    "png"  ],  "variables": [    {      "key": "headline.text",      "label": "Headline",      "kind": "text",      "exposed": true    }  ]}

Publish a form POST

Freezes the current draft as a new immutable version and puts it live, returning the URLs you need to embed it. Call it again after any `PATCH` to roll those edits out; each call increments `version`. Published versions are never mutated, so submissions always resolve against the exact form that was filled in.

Disconnect a form from its template DELETE

Submissions stop generating documents. The mapping is kept, so reconnecting the same template restores it rather than making you rebuild it.