# n8n & Make Workflow Documentation Generator (`spqr79/automation-documentation-generator`) Actor Generate professional Markdown, DOCX & PDF documentation from n8n workflows and Make blueprints. Powered by Claude Sonnet AI. Supports DE, EN, FR, ES. - **URL**: https://apify.com/spqr79/automation-documentation-generator.md - **Developed by:** [Spqr79](https://apify.com/spqr79) (community) - **Categories:** Developer tools, AI, Automation - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, NaN bookmarks - **User rating**: No ratings yet ## Pricing from $0.29 / documentation generated This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## Automation Documentation Generator — n8n & Make **Turn any n8n workflow export or Make blueprint into a professional technical document in seconds.** Paste your workflow JSON, and the Actor generates a complete Markdown, DOCX, and PDF report — covering overview, step-by-step flow, connected services, error handling, risks, maintenance notes, and a test plan checklist. Powered by **Claude Sonnet** (Anthropic). --- ### Example Output ![Example Report](https://i.imgur.com/NUEkOUF.png) [📄 Download Full Example Report (PDF)](https://github.com/spqr79/automation-documentation-generator/raw/main/assets/example-report.pdf) --- ### What it does - Parses your n8n or Make workflow JSON automatically - Detects the workflow language (DE, EN, FR, ES) — or set it manually - Identifies triggers, nodes, connected services, disabled steps, and error handlers - Generates a structured technical document with: - Overview & business purpose - Step-by-step flow - Connected services - Error handling assessment - Risks & findings - Maintenance recommendations - Assumptions & open points - Test plan checklist (optional) - Outputs **Markdown**, **DOCX**, and **PDF** in one run --- ### Input | Field | Required | Description | |-------|----------|-------------| | `platform` | ✅ | `n8n` or `make` | | `workflowJson` | ✅ | Paste your exported workflow JSON or Make blueprint | | `language` | optional | `de`, `en`, `fr`, `es` — auto-detected if left empty | | `includeTestPlan` | optional | Include test checklist (default: `true`) | #### How to export your workflow JSON **n8n:** Open your workflow → three-dot menu → Download → paste the JSON here **Make:** Open your scenario → More → Export Blueprint → paste the JSON here --- ### Output After each run, four files are available in **Storage → Key-Value Store**: | Key | Format | Description | |-----|--------|-------------| | `report.md` | Markdown | Full documentation as plain Markdown | | `report.docx` | Word | Formatted Word document | | `report.pdf` | PDF | Print-ready PDF via LibreOffice | | `report.json` | JSON | Structured metadata + documentation | The dataset also contains a summary record with workflow metadata and all report keys. --- ### Requirements Set the following environment variable in the Actor settings: | Variable | Description | |----------|-------------| | `ANTHROPIC_API_KEY` | Your Anthropic API key (`sk-ant-...`) | Get your key at [console.anthropic.com](https://console.anthropic.com). --- ### Supported platforms - **n8n** — workflow exports (JSON) - **Make** (formerly Integromat) — blueprints (JSON) --- ### Notes - Maximum input size: 500 KB - Workflows with more than 20 nodes: the first 20 steps are documented in detail, remaining steps are noted - Language detection is based on node names, labels, and descriptions in the workflow - LibreOffice is used for DOCX → PDF conversion inside the container # Actor input Schema ## `platform` (type: `string`): Which automation platform did you export from? ## `workflowJson` (type: `string`): Paste your n8n workflow JSON or Make blueprint JSON here. ## `language` (type: `string`): Language for the generated documentation. Leave empty for automatic detection based on workflow content. ## `includeTestPlan` (type: `boolean`): Include a compact validation checklist in the output ## Actor input object example ```json { "platform": "n8n", "workflowJson": "{\"name\":\"Example Workflow\",\"nodes\":[{\"id\":\"1\",\"name\":\"Webhook\",\"type\":\"n8n-nodes-base.webhook\",\"position\":[240,300],\"parameters\":{}},{\"id\":\"2\",\"name\":\"Send Email\",\"type\":\"n8n-nodes-base.gmail\",\"position\":[460,300],\"parameters\":{}},{\"id\":\"3\",\"name\":\"Error Trigger\",\"type\":\"n8n-nodes-base.errorTrigger\",\"position\":[240,500],\"parameters\":{}}],\"connections\":{\"Webhook\":{\"main\":[[{\"node\":\"Send Email\",\"type\":\"main\",\"index\":0}]]}},\"active\":true,\"settings\":{}}", "includeTestPlan": true } ```` # Actor output Schema ## `markdownReport` (type: `string`): No description ## `pdfReport` (type: `string`): No description ## `docxReport` (type: `string`): No description ## `jsonReport` (type: `string`): No description # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "workflowJson": "{\"name\":\"Example Workflow\",\"nodes\":[{\"id\":\"1\",\"name\":\"Webhook\",\"type\":\"n8n-nodes-base.webhook\",\"position\":[240,300],\"parameters\":{}},{\"id\":\"2\",\"name\":\"Send Email\",\"type\":\"n8n-nodes-base.gmail\",\"position\":[460,300],\"parameters\":{}},{\"id\":\"3\",\"name\":\"Error Trigger\",\"type\":\"n8n-nodes-base.errorTrigger\",\"position\":[240,500],\"parameters\":{}}],\"connections\":{\"Webhook\":{\"main\":[[{\"node\":\"Send Email\",\"type\":\"main\",\"index\":0}]]}},\"active\":true,\"settings\":{}}" }; // Run the Actor and wait for it to finish const run = await client.actor("spqr79/automation-documentation-generator").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "workflowJson": "{\"name\":\"Example Workflow\",\"nodes\":[{\"id\":\"1\",\"name\":\"Webhook\",\"type\":\"n8n-nodes-base.webhook\",\"position\":[240,300],\"parameters\":{}},{\"id\":\"2\",\"name\":\"Send Email\",\"type\":\"n8n-nodes-base.gmail\",\"position\":[460,300],\"parameters\":{}},{\"id\":\"3\",\"name\":\"Error Trigger\",\"type\":\"n8n-nodes-base.errorTrigger\",\"position\":[240,500],\"parameters\":{}}],\"connections\":{\"Webhook\":{\"main\":[[{\"node\":\"Send Email\",\"type\":\"main\",\"index\":0}]]}},\"active\":true,\"settings\":{}}" } # Run the Actor and wait for it to finish run = client.actor("spqr79/automation-documentation-generator").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "workflowJson": "{\\"name\\":\\"Example Workflow\\",\\"nodes\\":[{\\"id\\":\\"1\\",\\"name\\":\\"Webhook\\",\\"type\\":\\"n8n-nodes-base.webhook\\",\\"position\\":[240,300],\\"parameters\\":{}},{\\"id\\":\\"2\\",\\"name\\":\\"Send Email\\",\\"type\\":\\"n8n-nodes-base.gmail\\",\\"position\\":[460,300],\\"parameters\\":{}},{\\"id\\":\\"3\\",\\"name\\":\\"Error Trigger\\",\\"type\\":\\"n8n-nodes-base.errorTrigger\\",\\"position\\":[240,500],\\"parameters\\":{}}],\\"connections\\":{\\"Webhook\\":{\\"main\\":[[{\\"node\\":\\"Send Email\\",\\"type\\":\\"main\\",\\"index\\":0}]]}},\\"active\\":true,\\"settings\\":{}}" }' | apify call spqr79/automation-documentation-generator --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=spqr79/automation-documentation-generator", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "n8n & Make Workflow Documentation Generator", "description": "Generate professional Markdown, DOCX & PDF documentation from n8n workflows and Make blueprints. Powered by Claude Sonnet AI. Supports DE, EN, FR, ES.", "version": "1.0", "x-build-id": "4UpalU2N6d0ioCfFE" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/spqr79~automation-documentation-generator/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-spqr79-automation-documentation-generator", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/spqr79~automation-documentation-generator/runs": { "post": { "operationId": "runs-sync-spqr79-automation-documentation-generator", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/spqr79~automation-documentation-generator/run-sync": { "post": { "operationId": "run-sync-spqr79-automation-documentation-generator", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "platform", "workflowJson" ], "properties": { "platform": { "title": "Platform", "enum": [ "n8n", "make" ], "type": "string", "description": "Which automation platform did you export from?", "default": "n8n" }, "workflowJson": { "title": "Workflow JSON", "type": "string", "description": "Paste your n8n workflow JSON or Make blueprint JSON here." }, "language": { "title": "Documentation Language", "enum": [ "de", "en", "fr", "es" ], "type": "string", "description": "Language for the generated documentation. Leave empty for automatic detection based on workflow content." }, "includeTestPlan": { "title": "Include Test Plan", "type": "boolean", "description": "Include a compact validation checklist in the output", "default": true } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } } ```