Skip to main content

/[id]/images

The /diagrams/[id]/images endpoint is used for returning diagram elements as a base64 encoded string. The default image type returned is png. The [id] path parameter is required, and corresponds to the Element ID of the diagram for which you want an image to be returned.

Example 1

Return the base64 encoded image of the diagram represented by the element ID "_2024x_1_6620221_1743772257105_823925_19977"

curl 'http://127.0.0.1:8090/mb/v1/diagrams/_2024x_1_6620221_1743772257105_823925_19977/images'

Example 2

Return a base64 encoded image, decode it, and save it as an image. Example uses bash cli.

curl 'http://127.0.0.1:8090/mb/v1/diagrams/_2024x_1_6620221_1743772257105_823925_19977/images' | base64 -d > rocket.png

Query Parameters

The /diagrams/[id]/images endpoint supports one query parameter:

  1. format