Workflow Diagram API

Description: Returns the workflow diagram in Mermaid format. This can be used to visualize your workflow using Mermaid.

Try it out: Swagger Reference

Request Syntax:

GET /workflows/{workflow_id}/diagram
Authentication: Bearer <Your API key>

Response Syntax:

{
    "diagram": ""
}

Retrieve Diagram Response Example

{
    "diagram": "graph TD\n    model[\"model<br/>Model node\"]\n    slack_integration[\"slack_integration<br/>\"]\n    START((START))\n    END((END))\n    slack_integration --> END\n    START --> model\n    model --> slack_integration\n    style model fill:#bbf,stroke:#333,stroke-width:1px,color:#fff\n    style slack_integration fill:#bbf,stroke:#333,stroke-width:1px,color:#fff\n    style START fill:#9f9,stroke:#333,stroke-width:2px,color:#fff\n    style END fill:#f99,stroke:#333,stroke-width:2px,color:#fff"
}

Response Syntax Variables

• Diagram: a breakdown of the workflow diagram in Mermaid format