Documents
Report DOCX generation
Generate a styled DOCX report from a shared report model for editable decision memos, diligence reports, and client-facing documents.
Browser note: GET on this URL serves human-readable docs. Paid execution still requires POST with x402 settlement.
Best when the report needs editing, markup, or revision in a standard document workflow.
Example request body
Use this payload shape for the paid POST call.
{
"report_meta": {
"report_type": "board-update",
"title": "Board Update",
"author": "AurelianFlo"
},
"executive_summary": [
"Highlights are ready for review."
],
"headline_metrics": [
{
"label": "Revenue",
"value": "$42k"
}
],
"tables": {
"pipeline": {
"columns": [
"stage",
"status"
],
"rows": [
{
"stage": "Draft",
"status": "complete"
}
]
}
}
}Request schema
The canonical body contract as exposed through discovery and OpenAPI.
{
"type": "object",
"properties": {
"report_meta": {
"type": "object",
"properties": {
"report_type": {
"type": "string"
},
"title": {
"type": "string"
},
"report_title": {
"type": "string"
},
"name": {
"type": "string"
},
"author": {
"type": "string"
},
"owner": {
"type": "string"
},
"date": {
"type": "string"
},
"version": {
"type": "string"
}
},
"additionalProperties": true
},
"executive_summary": {
"type": "array",
"items": {
"type": "string"
}
},
"headline_metrics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string"
},
"value": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"unit": {
"type": "string"
}
},
"required": [
"label"
],
"additionalProperties": true
}
},
"tables": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"columns": {
"type": "array",
"items": {
"type": "string"
}
},
"rows": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
{
"type": "array",
"items": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
}
]
}
}
},
"additionalProperties": true
}
},
"export_artifacts": {
"type": "object",
"properties": {
"workbook_rows": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
{
"type": "array",
"items": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
}
]
}
}
}
},
"additionalProperties": true
},
"chart_hints": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
},
"result": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"report_meta"
],
"additionalProperties": true
}Example response
A representative output payload for the route.
{
"success": true,
"data": {
"endpoint": "/api/tools/docx/generate",
"tool": "DOCX Generate",
"handlerMode": "auto_local",
"previewToken": "17-docx-generate"
},
"source": "auto-local-engine"
}cURL
Use this as the starting point for HTTP execution after the initial 402 challenge.
curl -X POST "https://api.aurelianflo.com/api/tools/report/docx/generate" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
# include x402 settlement headers after the initial 402 challenge \
-d '{
"report_meta": {
"report_type": "board-update",
"title": "Board Update",
"author": "AurelianFlo"
},
"executive_summary": [
"Highlights are ready for review."
],
"headline_metrics": [
{
"label": "Revenue",
"value": "$42k"
}
],
"tables": {
"pipeline": {
"columns": [
"stage",
"status"
],
"rows": [
{
"stage": "Draft",
"status": "complete"
}
]
}
}
}'Related routes
Use these when you want the lower-level primitive, the buyer-facing memo workflow, or the agent install surface around this endpoint.
This route is documented as a standalone endpoint. Use the service catalog for adjacent workflows.