Wardley Mapping Developer Portal
Wardley Maps Crew API (ALPHA)

Conversions

Endpoint:https://api.wardleymaps.ai

Convert from one Wardley Mapping format to another

Convert OWM to TOML

POST
https://api.wardleymaps.ai
/v2/convertowm2toml

Converts an OWM (Open Wardley Map) to TOML (Tom's Obvious, Minimal Language)

Convert OWM to TOML › Headers

  • Authorizationstring · required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Convert OWM to TOML › Request Body

  • owmtextstring · required

Convert OWM to TOML › Responses

TOML version of the Wardley Map

  • owmtomlstring

    The TOML representation of the Wardley Map

Convert OWM to JSON

POST
https://api.wardleymaps.ai
/v2/convertowm2json

Converts OWM (Open Wardley Map) to JSON format.

Convert OWM to JSON › Headers

  • Authorizationstring · required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Convert OWM to JSON › Request Body

  • owmtextstring · required

Convert OWM to JSON › Responses

JSON version of the Wardley Map

  • owmjsonstring

    The JSON representation of the Wardley Map

Convert OWM to YAML

POST
https://api.wardleymaps.ai
/v2/convertowm2yaml

Converts OWM (Open Wardley Map) to YAML format.

Convert OWM to YAML › Headers

  • Authorizationstring · required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Convert OWM to YAML › Request Body

  • owmtextstring · required

Convert OWM to YAML › Responses

YAML version of the Wardley Map

  • owmjsonstring

    The YAML representation of the Wardley Map

Convert OWM to PNG

POST
https://api.wardleymaps.ai
/v2/convertowm2png

Returns a URL of an image of a Wardley Map, passed as string.

Convert OWM to PNG › Headers

  • Authorizationstring · required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Convert OWM to PNG › Request Body

  • owmtextstring · required

Convert OWM to PNG › Responses

Successful response

  • image_urlstring · required

    The URL of the generated Wardley Map image

Convert OWM to SVG

POST
https://api.wardleymaps.ai
/v2/convertowm2svg

Converts a Wardley Map in Open Wardley Map (OWM) format to an SVG image.

Convert OWM to SVG › Headers

  • Authorizationstring · required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Convert OWM to SVG › Request Body

  • owmtextstring · required

Convert OWM to SVG › Responses

SVG image URL

  • image_urlstring · required

    The URL of the generated Wardley Map image

Convert Map ID to PNG

POST
https://api.wardleymaps.ai
/v2/convertid2png

Generate a Wardley Map PNG from Map ID.

Convert Map ID to PNG › Headers

  • Authorizationstring · required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Convert Map ID to PNG › Request Body

  • map_idstring · minLength: 18 · maxLength: 18 · required

    The ID of the Wardley Map from create.wardleymaps.ai

Convert Map ID to PNG › Responses

Successful response

  • image_urlstring · required

    The URL of the generated Wardley Map image

Wardley Maps Online (create.wardleymaps.ai)Knowledge Base