Generate synchronously

Submit a generation request and receive the document in the response.

POST /generate/sync returns the generated document on the same connection.

Requires the X-Api-Key header.

Request body

Send application/json using GenerateRequest.

Property	Type	Description
data	array<SectionItem>	Sections to render. Supply at least one.
format	string	Output format. Only docx is supported.
metadata	object	Business-context metadata.
style	StyleConfig	Styling configuration.
webhookUrl	string	HTTPS completion webhook URL.

Section item

Property	Type	Description
sectionData	object	Section-specific data.
sectionKey	string	Unique section identifier.

Style configuration

Property	Type	Description
fontFamily	string	Font family.
fontSize	integer	Font size from 8 through 72.
headerFooter	boolean	Include headers and footers.
lenderName	string	Lender or company name.
pageNumbers	boolean	Include page numbers.
primaryColor	string	Primary hex color.
secondaryColor	string	Secondary hex color.
tableOfContents	boolean	Include a table of contents.

Responses

Status	Description
200	Generated DOCX returned as application/vnd.openxmlformats-officedocument.wordprocessingml.document. The response is binary, not JSON. Write the body to disk.
400	The request body is missing or invalid.
401	The API key is missing or invalid.

Example

curl -X POST "https://<api-host>/generate/sync" \
  -H "X-Api-Key: $DOCAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
         "data": [
           {
             "sectionKey": "borrower",
             "sectionData": {
               "name": "Northwind Trading Co.",
               "entityType": "Corporation"
             }
           }
         ],
         "format": "docx"
       }'