flows

Export a flow

Renders the flow through the same pipeline the app uses. pdf is the delivery document (diagram plus execution plan); png is the dependency diagram on its own. Responds with the bytes, Content-Disposition set.

post/v1/flows/{flowId}/exports

Request

  • Base URL: https://api.flowral.app
  • URL: https://api.flowral.app/v1/flows/{flowId}/exports
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (client credentials, token URL https://api.flowral.app/v1/oauth/token, scopes: flows:read)

Path parameters

flowIdstring required

Request body

formatstring required

pdf or png.

Response

SUCCESS — application/pdf or image/png.

Changes

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