One-shot document generation

One-shot document generation - POST /documents/generate. DocDealer REST API reference.

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

documentId?string

Optional existing document id to reuse for this run. Use when formData contains attachment-analysis refs that belong to a live document.

ephemeral?boolean

Run entirely in-memory without creating a persisted document row. Requires templateSource.

formData*

Flat record of form values keyed by "objectId.entryIndex.fieldId" (same shape as set_form_value).

generateTitle?boolean

Generate a title from the current form values. Defaults to true only when title is omitted; pass false to keep the template/default title.

returnHtml?boolean

Return generated HTML instead of a DOCX blob. Default false.

strict?boolean

Fail the whole request if any generation or validation phase fails. Ephemeral runs default to strict unless explicitly disabled.

templateId?string

Template id — see list_templates.

templateSource?string

Optional plaintext template source (frontmatter + HTML) to use for this run.

title?string

Optional document title. Falls back to the template title.

validateDocument?boolean

Run document-content validation in parallel with export. Default false.

validateForm?boolean

Run form validation in parallel with section generation. Default false.

Response Body

`application/json`

curl -X POST "https://example.com/documents/generate" \  -H "Content-Type: application/json" \  -d '{    "formData": {      "property1": null,      "property2": null    }  }'

null

One-shot document generation

Authorization

Request Body

Response Body

200application/json

`application/json`