Marketplace/faro-document-generator

Document Generator

Active

by Faro

1 tool

upstream:

Generate Microsoft Word (.docx) documents from a structured block list — headings, paragraphs (with bold/italic runs), bullets, numbered lists, tables, and page breaks. Returns a short-lived download URL.

Developer Toolsdocxworddocumentgenerate

Tools (1)

▶generate

Generate a .docx file from a block list. Returns a pre-signed download URL.

Usage-based · 1 credit per Word document generated.

Example prompts

“Generate a Word document with a title and three sections summarising my product launch plan”
“Create a meeting minutes .docx with attendees, agenda, decisions, and action items as tables”
“Build a one-page resume in Word format with a header table for contact info and bulleted work history”
“Produce a .docx project status report with tables for milestones and risks”
“Generate a Word invoice with a line-item table and totals”

Parameters

titlestringoptional

Document title. Becomes the docx core property and is rendered as a level-0 heading.

blocksarrayrequired

Ordered list of content blocks. Supported types: heading, paragraph, bullets, numbered, table, page_break.

filenamestringoptionaldefault: "document.docx"

Filename for the generated docx (shown in download URL and storage key).

expires_inintegeroptionaldefault: 3600

Seconds the download URL stays valid (default 1h, max 24h).

API Usage

curl -X POST "https://api.askfaro.com/invoke/faro-document-generator/generate" \
  -H "Authorization: Bearer <your_api_key>" \
  -H "Content-Type: application/json" \
  -d '{
  "arguments": {
    "blocks": []
  }
}'

CLI Usage

faro invoke faro-document-generator/generate --params '{"blocks":[]}'

Install pip install askfaro-cli, then faro auth login.

▶README

Document Generator

Generate Microsoft Word (.docx) documents programmatically from a structured JSON description. Returns a pre-signed download URL valid for up to 24 hours.

Inputs

Name	Type	Default	Description
`title`	string	none	Optional document title (also rendered as a level-0 heading).
`filename`	string	`document.docx`	Filename in the download URL.
`blocks`	array	required	Ordered content blocks. See block types below.
`expires_in`	integer	`3600`	Download URL TTL in seconds (60 – 86400).

Block types

{ "type": "heading", "text": "Section title", "level": 1 }     // level 1-9
{ "type": "paragraph", "text": "plain text" }
{ "type": "paragraph", "runs": [
    { "text": "Key metrics: ", "bold": true },
    { "text": "ARR $24M" }
] }
{ "type": "bullets", "items": ["first", "second"] }
{ "type": "numbered", "items": ["one", "two"] }
{ "type": "table", "header": true, "rows": [["Col A","Col B"], ["r1a","r1b"]] }
{ "type": "page_break" }

Up to 1000 blocks per document.

Output

{
  "download_url": "https://…/tool-outputs/…/<file>.docx",
  "key": "tool-outputs/…",
  "size_bytes": 37107,
  "mime": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
  "expires_at": "2026-05-15T12:00:00Z"
}

Pricing

1 credit per document generated. Flat rate — cost is independent of block count, table size, or document length.