generators

Render every diagram of a multi-diagram project

Public, CORS-open endpoint; 30 requests per minute per client IP (counted separately from /api/diagram/generate). The client IP is the first X-Forwarded-For entry, else X-Real-IP, else one shared unknown bucket; counters are kept in memory per server instance and per route. Each entry of diagrams is rendered as its own SVG. Each bridge adds a virtual load to the diagram whose id equals fromDiagramId and a virtual charger plus power source to the diagram whose id equals toDiagramId. The response is always JSON; with Accept: image/png each diagram additionally carries a base64 PNG (null when not requested or when conversion failed). Component icons are embedded as in /api/diagram/generate. No external API is called.

post/api/project/generate

Request

  • Base URL: https://voltplan.app
  • URL: https://voltplan.app/api/project/generate
  • Auth: none declared

Request body

projectNamestring

Echoed back in the response.

Response

Rendered diagrams in request order.

projectNamestring

Omitted when the request had none.

Changes

No recorded changes to this operation across all 1 revision of this API.