Sign in

v1

latestOpenAPI 3.1.02026-07-13121824.2 KB
Mermaid

Render Mermaid Diagram

Validate and render a Mermaid diagram from pre-generated Mermaid code (MCP server endpoint).

AUTHENTICATION REQUIRED - Must include valid JWT token in Authorization header.

This endpoint is specifically for the MCP server to render diagrams from Mermaid code generated by ChatGPT. It validates syntax using the official mermaid.js parser and saves the diagram to the database.

Args: render_request: MermaidRenderRequest containing mermaid_code and diagram_type request: FastAPI Request object (required for rate limiting) current_user: Authenticated user (injected by Auth0 middleware) db: Database session

Returns: MermaidResponse with validated Mermaid code and saved diagram ID

Rate limit: Configurable via RATE_LIMIT_PER_MINUTE env var (default: 10/minute)

post/api/render-mermaid

Request body

mermaid_codestring required

Pre-generated Mermaid diagram code to validate and render (10-50000 characters)

titlestring required

Diagram title generated by ChatGPT

diagram_type'flowchart' | 'sequence' | 'mindmap' | 'auto'

Type of diagram (flowchart, sequence, mindmap, or auto to detect)

Example request

{
  "mermaid_code": "flowchart TD\n  A[Start] --> B[End]",
  "title": "User Login Flow",
  "diagram_type": "flowchart"
}

Response

Successful Response

mermaidCodestring required

Generated Mermaid diagram syntax

titlestring required

Diagram title extracted from description

diagram_type'flowchart' | 'sequence' | 'mindmap'

Type of diagram generated

savedDiagramIdinteger nullable

ID of the auto-saved diagram (if save was successful)

diagram_jsonobject nullable

Current diagram state from database (for edit operations, used in visual diff)

Example response

{
  "mermaidCode": "flowchart TB\n  start([Start])\n  finish([End])\n  start --> finish",
  "savedDiagramId": 123,
  "title": "User login flow with authentication..."
}