Wardley Maps Crew API (ALPHA)

Open Wardley Maps

Endpoint:https://api.wardleymaps.ai

API endpoints related to Open Wardley Maps

Create a Wardley Map from Map Text

POST

https://api.wardleymaps.ai

/v2/generate-mapfromtext

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

Create a Wardley Map from Map Text › 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.

Create a Wardley Map from Map Text › Request Body

owmtextstring · required

Create a Wardley Map from Map Text › Responses

Successful response

image_urlstring · required
The URL of the generated Wardley Map image

Create a Wardley Map from a Map ID

POST

https://api.wardleymaps.ai

/v2/generate-mapfromid

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

Create a Wardley Map from a Map ID › 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.

Create a Wardley Map from a Map ID › Request Body

map_idstring · minLength: 18 · maxLength: 18 · required
The ID of the Wardley Map from create.wardleymaps.ai

Create a Wardley Map from a Map ID › Responses

Successful response

image_urlstring · required
The URL of the generated Wardley Map image

Retrieve Warnings for a specific Wardley Map

POST

https://api.wardleymaps.ai

/v2/get-owm-warnings

Retrieve warnings for a specific Wardley Map by providing the map ID.

Retrieve Warnings for a specific Wardley Map › 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.

Retrieve Warnings for a specific Wardley Map › Request Body

map_idstring · minLength: 18 · maxLength: 18 · required
The ID of the Wardley Map from create.wardleymaps.ai

Retrieve Warnings for a specific Wardley Map › Responses

Successful response with warnings and original Map Text

warningsstring[]
List of warnings found in the map

Retrieve Components of a specific Wardley Map

POST

https://api.wardleymaps.ai

/v2/get-owm-components

Retrieve the components of a specific Wardley Map by providing the map ID.

Retrieve Components of a specific Wardley Map › 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.

Retrieve Components of a specific Wardley Map › Request Body

map_idstring · minLength: 18 · maxLength: 18 · required
The ID of the Wardley Map from create.wardleymaps.ai

Retrieve Components of a specific Wardley Map › Responses

namestring
evolutionstring
visibilitystring

Retrieve details of a specific component of a Wardley Map

POST

https://api.wardleymaps.ai

/v2/get-owm-component

This endpoint allows users to retrieve details of a specific component of a Wardley Map.

Retrieve details of a specific component of a Wardley Map › 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.

Retrieve details of a specific component of a Wardley Map › Request Body

map_idstring · required
The ID of the Wardley Map
namestring · required

Retrieve details of a specific component of a Wardley Map › Responses

namestring
evolutionstring
visibilitystring

Retrieve Anchors of a specific Wardley Map

POST

https://api.wardleymaps.ai

/v2/get-owm-anchors

This endpoint retrieves the anchors of a specific Wardley Map.

Retrieve Anchors of a specific Wardley Map › 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.

Retrieve Anchors of a specific Wardley Map › Request Body

map_idstring · minLength: 18 · maxLength: 18 · required
The ID of the Wardley Map from create.wardleymaps.ai

Retrieve Anchors of a specific Wardley Map › Responses

namestring
evolutionstring
visibilitystring

Retrieve Pipelines of a specific Wardley Map

POST

https://api.wardleymaps.ai

/v2/get-owm-pipelines

Retrieve the pipelines associated with a specific Wardley Map

Retrieve Pipelines of a specific Wardley Map › 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.

Retrieve Pipelines of a specific Wardley Map › Request Body

map_idstring · minLength: 18 · maxLength: 18 · required
The ID of the Wardley Map from create.wardleymaps.ai

Retrieve Pipelines of a specific Wardley Map › Responses

namestring
evolutionstring
visibilitystring

Retrieve Notes of a specific Wardley Map

POST

https://api.wardleymaps.ai

/v2/get-owm-notes

Retrieve the notes of a specific Wardley Map by providing the map ID.

Retrieve Notes of a specific Wardley Map › 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.

Retrieve Notes of a specific Wardley Map › Request Body

map_idstring · minLength: 18 · maxLength: 18 · required
The ID of the Wardley Map from create.wardleymaps.ai

Retrieve Notes of a specific Wardley Map › Responses

namestring
evolutionstring
visibilitystring

Retrieve Annotations of a specific Wardley Map

POST

https://api.wardleymaps.ai

/v2/get-owm-annotations

This endpoint retrieves the annotations of a specific Wardley Map.

Retrieve Annotations of a specific Wardley Map › 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.

Retrieve Annotations of a specific Wardley Map › Request Body

map_idstring · minLength: 18 · maxLength: 18 · required
The ID of the Wardley Map from create.wardleymaps.ai

Retrieve Annotations of a specific Wardley Map › Responses

namestring
evolutionstring
visibilitystring

Retrieve Map Text in OWM format of a specific Wardley Map

POST

https://api.wardleymaps.ai

/v2/get-owm-text

Retrieve the text representation of a specific Wardley Map in OWM format.

Retrieve Map Text in OWM format of a specific Wardley Map › 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.

Retrieve Map Text in OWM format of a specific Wardley Map › Request Body

map_idstring · minLength: 18 · maxLength: 18 · required
The ID of the Wardley Map from create.wardleymaps.ai

Retrieve Map Text in OWM format of a specific Wardley Map › Responses

owmtextstring · required

Search for Components in a Wardley Map

POST

https://api.wardleymaps.ai

/v2/search-owm-components

Endpoint to search for components within a Wardley Map

Search for Components in a Wardley Map › 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.

Search for Components in a Wardley Map › Request Body

search_termstring · required
map_idstring · required
The ID of the Wardley Map

Search for Components in a Wardley Map › Responses

namestring
evolutionstring
visibilitystring

Wardley Maps Online (create.wardleymaps.ai)