logo
Getting Started
API Reference
Authentication
Open Wardley Maps
Create a Wardley Map from Map Text
Create a Wardley Map from a Map ID
Retrieve a generated Wardley Map image
Retrieve Warnings for a specific Wardley Map
Retrieve Components of a specific Wardley Map
Retrieve details of a specific component of a Wardley Map
Retrieve Anchors of a specific Wardley Map
Retrieve Pipelines of a specific Wardley Map
Retrieve Notes of a specific Wardley Map
Retrieve Annotations of a specific Wardley Map
Retrieve Map Text in OWM format of a specific Wardley Map
Search for Components in a Wardley Map
Wardley Maps Online (create.wardleymaps.ai)
Save a Wardley Map to create.wardleymaps.ai
Get a Wardley Map from create.wardleymaps.ai
Conversions
Convert OWM to TOML
Convert OWM to JSON
Convert OWM to YAML
Convert OWM to PNG
Convert OWM to SVG
Convert Map ID to PNG
Knowledge Base
Query the Wardley Mapping Book
Query the Wardley Mapping Diagrams
Query the Wardley Mapping Videos
Analyse an Image of a Wardley Map
Tools
List GitHub Wardley Maps
Get GitHub Wardley Map Content
powered by zuplo
DocsPricingSign in

Wardley Maps Crew API (ALPHA)

API for interacting with the Wardley Maps Crew

BASE URL
https://api.wardleymaps.ai

Authentication

Sign into view and manage your API credentials

Open Wardley Maps

API endpoints related to Open Wardley Maps

ENDPOINTS
POST/v2/generate-mapfromtext
POST/v2/generate-mapfromid
GET/v2/image/:filename
POST/v2/get-owm-warnings
POST/v2/get-owm-components
POST/v2/get-owm-component
POST/v2/get-owm-anchors
POST/v2/get-owm-pipelines
POST/v2/get-owm-notes
POST/v2/get-owm-annotations
POST/v2/get-owm-text
POST/v2/search-owm-components

Wardley Maps Online (create.wardleymaps.ai)

Operations related to Wardley Maps Online

ENDPOINTS
POST/v2/maps/save
GET/v2/maps/fetch

Conversions

Convert from one Wardley Mapping format to another

ENDPOINTS
POST/v2/convertowm2toml
POST/v2/convertowm2json
POST/v2/convertowm2yaml
POST/v2/convertowm2png
POST/v2/convertowm2svg
POST/v2/convertid2png

Tools

Tools for managing Wardley Maps

ENDPOINTS
GET/v2/list-github-maps
GET/v2/get-github-map

Knowledge Base

Operations related to the Wardley Mapping knowledge base

ENDPOINTS
POST/v1/querywardleybook
POST/v1/querywardleydiagrams
POST/v1/querywardleyvideos
POST/v1/analyse-wardleymap-image

Create a Wardley Map from Map Text

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

Protected by API Key

Headers

Authorization

required, string

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

Request Body

owmtext

required, string
POST
/v2/generate-mapfromtext
1
EXAMPLE BODY
{
  "owmtext": "title Tea Shop\nanchor Business [0.95, 0.63]\nanchor Public [0.95, 0.78]\ncomponent Cup of Tea [0.79, 0.61] label [19, -4]\ncomponent Cup [0.73, 0.78]\ncomponent Tea [0.63, 0.81]\ncomponent Hot Water [0.52, 0.80]\ncomponent Water [0.38, 0.82]\ncomponent Kettle [0.43, 0.35] label [-57, 4]\nevolve Kettle 0.62 label [16, 7]\ncomponent Power [0.1, 0.7] label [-27, 20]\nevolve Power 0.89 label [-12, 21]\nBusiness->Cup of Tea\nPublic->Cup of Tea\nCup of Tea->Cup\nCup of Tea->Tea\nCup of Tea->Hot Water\nHot Water->Water\nHot Water->Kettle\nKettle->Power\n\nannotation 1 [[0.43,0.49],[0.08,0.79]] Standardising power allows Kettles to evolve faster\nannotation 2 [0.48, 0.85] Hot water is obvious and well known\nannotations [0.60, 0.02]\n\nnote +a generic note appeared [0.23, 0.33]\n\nstyle wardley"
}

Create a Wardley Map from a Map ID

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

Protected by API Key

Headers

Authorization

required, string

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

Request Body

map_id

required, string, maximum length of 18, minimum length of 18

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

POST
/v2/generate-mapfromid
1
EXAMPLE BODY
{
  "map_id": "30f8e6a71f39253704"
}

Retrieve a generated Wardley Map image

Returns the image file generated by the /generate-map endpoint.

Protected by API Key

Headers

Authorization

required, string

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

Path Parameters

filename

required, string

The name of the Wardley Map image file to retrieve

GET
/v2/image/:filename
1

Retrieve Warnings for a specific Wardley Map

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

Protected by API Key

Headers

Authorization

required, string

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

Request Body

map_id

required, string, maximum length of 18, minimum length of 18

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

POST
/v2/get-owm-warnings
1
EXAMPLE BODY
{
  "map_id": "30f8e6a71f39253704"
}

Retrieve Components of a specific Wardley Map

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

Protected by API Key

Headers

Authorization

required, string

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

Request Body

map_id

required, string, maximum length of 18, minimum length of 18

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

POST
/v2/get-owm-components
1
EXAMPLE BODY
{
  "map_id": "30f8e6a71f39253704"
}

Retrieve details of a specific component of a Wardley Map

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

Protected by API Key

Headers

Authorization

required, string

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

Request Body

map_id

required, string

The ID of the Wardley Map

name

required, string
POST
/v2/get-owm-component
1
EXAMPLE BODY
{
  "map_id": "30f8e6a71f39253704",
  "name": "AI Research"
}

Retrieve Anchors of a specific Wardley Map

This endpoint retrieves the anchors of a specific Wardley Map.

Protected by API Key

Headers

Authorization

required, string

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

Request Body

map_id

required, string, maximum length of 18, minimum length of 18

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

POST
/v2/get-owm-anchors
1
EXAMPLE BODY
{
  "map_id": "30f8e6a71f39253704"
}

Retrieve Pipelines of a specific Wardley Map

Retrieve the pipelines associated with a specific Wardley Map

Protected by API Key

Headers

Authorization

required, string

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

Request Body

map_id

required, string, maximum length of 18, minimum length of 18

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

POST
/v2/get-owm-pipelines
1
EXAMPLE BODY
{
  "map_id": "30f8e6a71f39253704"
}

Retrieve Notes of a specific Wardley Map

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

Protected by API Key

Headers

Authorization

required, string

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

Request Body

map_id

required, string, maximum length of 18, minimum length of 18

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

POST
/v2/get-owm-notes
1
EXAMPLE BODY
{
  "map_id": "30f8e6a71f39253704"
}

Retrieve Annotations of a specific Wardley Map

This endpoint retrieves the annotations of a specific Wardley Map.

Protected by API Key

Headers

Authorization

required, string

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

Request Body

map_id

required, string, maximum length of 18, minimum length of 18

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

POST
/v2/get-owm-annotations
1
EXAMPLE BODY
{
  "map_id": "30f8e6a71f39253704"
}

Retrieve Map Text in OWM format of a specific Wardley Map

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

Protected by API Key

Headers

Authorization

required, string

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

Request Body

map_id

required, string, maximum length of 18, minimum length of 18

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

POST
/v2/get-owm-text
1
EXAMPLE BODY
{
  "map_id": "30f8e6a71f39253704"
}

Search for Components in a Wardley Map

Endpoint to search for components within a Wardley Map

Protected by API Key

Headers

Authorization

required, string

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

Request Body

search_term

required, string

map_id

required, string

The ID of the Wardley Map

POST
/v2/search-owm-components
1
EXAMPLE BODY
{
  "map_id": "30f8e6a71f39253704",
  "search_term": "AI"
}

Save a Wardley Map to create.wardleymaps.ai

Saves the provided Wardley Map data to the create.wardleymap.ai and returns a link to edit the map.

Protected by API Key

Headers

Authorization

required, string

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

Request Body

text

required, string

The Online Wardley Map (OWM) in text format.

POST
/v2/maps/save
1
EXAMPLE BODY
{
  "text": "title Tea Shop\nanchor Business [0.95, 0.63]\nanchor Public [0.95, 0.78]\ncomponent Cup of Tea [0.79, 0.61] label [19, -4]\ncomponent Cup [0.73, 0.78]\ncomponent Tea [0.63, 0.81]\ncomponent Hot Water [0.52, 0.80]\ncomponent Water [0.38, 0.82]\ncomponent Kettle [0.43, 0.35] label [-57, 4]\nevolve Kettle 0.62 label [16, 7]\ncomponent Power [0.1, 0.7] label [-27, 20]\nevolve Power 0.89 label [-12, 21]\nBusiness->Cup of Tea\nPublic->Cup of Tea\nCup of Tea->Cup\nCup of Tea->Tea\nCup of Tea->Hot Water\nHot Water->Water\nHot Water->Kettle\nKettle->Power\n\nannotation 1 [[0.43,0.49],[0.08,0.79]] Standardising power allows Kettles to evolve faster\nannotation 2 [0.48, 0.85] Hot water is obvious and well known\nannotations [0.60, 0.02]\n\nnote +a generic note appeared [0.23, 0.33]\n\nstyle wardley"
}

Get a Wardley Map from create.wardleymaps.ai

Get a Wardley Map from create.wardleymaps.ai.

Protected by API Key

Headers

Authorization

required, string

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

Query Parameters

id

required, string

The Wardley Map ID to fetch.

GET
/v2/maps/fetch
1

Convert OWM to TOML

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

Protected by API Key

Headers

Authorization

required, string

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

Request Body

owmtext

required, string
POST
/v2/convertowm2toml
1
EXAMPLE BODY
{
  "owmtext": "title Tea Shop\nanchor Business [0.95, 0.63]\nanchor Public [0.95, 0.78]\ncomponent Cup of Tea [0.79, 0.61] label [19, -4]\ncomponent Cup [0.73, 0.78]\ncomponent Tea [0.63, 0.81]\ncomponent Hot Water [0.52, 0.80]\ncomponent Water [0.38, 0.82]\ncomponent Kettle [0.43, 0.35] label [-57, 4]\nevolve Kettle 0.62 label [16, 7]\ncomponent Power [0.1, 0.7] label [-27, 20]\nevolve Power 0.89 label [-12, 21]\nBusiness->Cup of Tea\nPublic->Cup of Tea\nCup of Tea->Cup\nCup of Tea->Tea\nCup of Tea->Hot Water\nHot Water->Water\nHot Water->Kettle\nKettle->Power\n\nannotation 1 [[0.43,0.49],[0.08,0.79]] Standardising power allows Kettles to evolve faster\nannotation 2 [0.48, 0.85] Hot water is obvious and well known\nannotations [0.60, 0.02]\n\nnote +a generic note appeared [0.23, 0.33]\n\nstyle wardley"
}

Convert OWM to JSON

Converts OWM (Open Wardley Map) to JSON format.

Protected by API Key

Headers

Authorization

required, string

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

Request Body

owmtext

required, string
POST
/v2/convertowm2json
1
EXAMPLE BODY
{
  "owmtext": "title Tea Shop\nanchor Business [0.95, 0.63]\nanchor Public [0.95, 0.78]\ncomponent Cup of Tea [0.79, 0.61] label [19, -4]\ncomponent Cup [0.73, 0.78]\ncomponent Tea [0.63, 0.81]\ncomponent Hot Water [0.52, 0.80]\ncomponent Water [0.38, 0.82]\ncomponent Kettle [0.43, 0.35] label [-57, 4]\nevolve Kettle 0.62 label [16, 7]\ncomponent Power [0.1, 0.7] label [-27, 20]\nevolve Power 0.89 label [-12, 21]\nBusiness->Cup of Tea\nPublic->Cup of Tea\nCup of Tea->Cup\nCup of Tea->Tea\nCup of Tea->Hot Water\nHot Water->Water\nHot Water->Kettle\nKettle->Power\n\nannotation 1 [[0.43,0.49],[0.08,0.79]] Standardising power allows Kettles to evolve faster\nannotation 2 [0.48, 0.85] Hot water is obvious and well known\nannotations [0.60, 0.02]\n\nnote +a generic note appeared [0.23, 0.33]\n\nstyle wardley"
}

Convert OWM to YAML

Converts OWM (Open Wardley Map) to YAML format.

Protected by API Key

Headers

Authorization

required, string

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

Request Body

owmtext

required, string
POST
/v2/convertowm2yaml
1
EXAMPLE BODY
{
  "owmtext": "title Tea Shop\nanchor Business [0.95, 0.63]\nanchor Public [0.95, 0.78]\ncomponent Cup of Tea [0.79, 0.61] label [19, -4]\ncomponent Cup [0.73, 0.78]\ncomponent Tea [0.63, 0.81]\ncomponent Hot Water [0.52, 0.80]\ncomponent Water [0.38, 0.82]\ncomponent Kettle [0.43, 0.35] label [-57, 4]\nevolve Kettle 0.62 label [16, 7]\ncomponent Power [0.1, 0.7] label [-27, 20]\nevolve Power 0.89 label [-12, 21]\nBusiness->Cup of Tea\nPublic->Cup of Tea\nCup of Tea->Cup\nCup of Tea->Tea\nCup of Tea->Hot Water\nHot Water->Water\nHot Water->Kettle\nKettle->Power\n\nannotation 1 [[0.43,0.49],[0.08,0.79]] Standardising power allows Kettles to evolve faster\nannotation 2 [0.48, 0.85] Hot water is obvious and well known\nannotations [0.60, 0.02]\n\nnote +a generic note appeared [0.23, 0.33]\n\nstyle wardley"
}

Convert OWM to PNG

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

Protected by API Key

Headers

Authorization

required, string

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

Request Body

owmtext

required, string
POST
/v2/convertowm2png
1
EXAMPLE BODY
{
  "owmtext": "title Tea Shop\nanchor Business [0.95, 0.63]\nanchor Public [0.95, 0.78]\ncomponent Cup of Tea [0.79, 0.61] label [19, -4]\ncomponent Cup [0.73, 0.78]\ncomponent Tea [0.63, 0.81]\ncomponent Hot Water [0.52, 0.80]\ncomponent Water [0.38, 0.82]\ncomponent Kettle [0.43, 0.35] label [-57, 4]\nevolve Kettle 0.62 label [16, 7]\ncomponent Power [0.1, 0.7] label [-27, 20]\nevolve Power 0.89 label [-12, 21]\nBusiness->Cup of Tea\nPublic->Cup of Tea\nCup of Tea->Cup\nCup of Tea->Tea\nCup of Tea->Hot Water\nHot Water->Water\nHot Water->Kettle\nKettle->Power\n\nannotation 1 [[0.43,0.49],[0.08,0.79]] Standardising power allows Kettles to evolve faster\nannotation 2 [0.48, 0.85] Hot water is obvious and well known\nannotations [0.60, 0.02]\n\nnote +a generic note appeared [0.23, 0.33]\n\nstyle wardley"
}

Convert OWM to SVG

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

Protected by API Key

Headers

Authorization

required, string

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

Request Body

owmtext

required, string
POST
/v2/convertowm2svg
1
EXAMPLE BODY
{
  "owmtext": "title Tea Shop\nanchor Business [0.95, 0.63]\nanchor Public [0.95, 0.78]\ncomponent Cup of Tea [0.79, 0.61] label [19, -4]\ncomponent Cup [0.73, 0.78]\ncomponent Tea [0.63, 0.81]\ncomponent Hot Water [0.52, 0.80]\ncomponent Water [0.38, 0.82]\ncomponent Kettle [0.43, 0.35] label [-57, 4]\nevolve Kettle 0.62 label [16, 7]\ncomponent Power [0.1, 0.7] label [-27, 20]\nevolve Power 0.89 label [-12, 21]\nBusiness->Cup of Tea\nPublic->Cup of Tea\nCup of Tea->Cup\nCup of Tea->Tea\nCup of Tea->Hot Water\nHot Water->Water\nHot Water->Kettle\nKettle->Power\n\nannotation 1 [[0.43,0.49],[0.08,0.79]] Standardising power allows Kettles to evolve faster\nannotation 2 [0.48, 0.85] Hot water is obvious and well known\nannotations [0.60, 0.02]\n\nnote +a generic note appeared [0.23, 0.33]\n\nstyle wardley"
}

Convert Map ID to PNG

Generate a Wardley Map PNG from Map ID.

Protected by API Key

Headers

Authorization

required, string

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

Request Body

The request body containing the Map ID.

map_id

required, string, maximum length of 18, minimum length of 18

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

POST
/v2/convertid2png
1
EXAMPLE BODY
{
  "map_id": "30f8e6a71f39253704"
}

List GitHub Wardley Maps

Endpoint to list all Wardley Maps related to GitHub

Protected by API Key

Headers

Authorization

required, string

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

GET
/v2/list-github-maps
1

Get GitHub Wardley Map Content

Retrieve the content of a Wardley Map from GitHub.

Protected by API Key

Headers

Authorization

required, string

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

Query Parameters

github_path

required, string

Path of the Wardley Map to retrieve.

GET
/v2/get-github-map
1

Query the Wardley Mapping Book

Ask a question about Wardley Mapping and get the answer from the Wardley Mapping book

Protected by API Key

Headers

Authorization

required, string

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

Request Body

unique_uuid

required, string

Generate a unique UUID identifier for this conversation with the user

query

required, string

The query to be processed about Wardley Mapping

POST
/v1/querywardleybook
1
EXAMPLE BODY
{
  "unique_uuid": "550e8400-e29b-41d4-a716-446655440000",
  "query": "Tell me about Wardley Mapping."
}

Query the Wardley Mapping Diagrams

Ask a question about Wardley Mapping diagrams within the book

Protected by API Key

Headers

Authorization

required, string

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

Request Body

unique_uuid

required, string

Generate a unique UUID identifier for this conversation with the user

query

required, string

The query to be processed about Wardley Mapping

POST
/v1/querywardleydiagrams
1
EXAMPLE BODY
{
  "unique_uuid": "550e8400-e29b-41d4-a716-446655440000",
  "query": "Tell me about Wardley Mapping."
}

Query the Wardley Mapping Videos

Returns a list of videos with start times of the segment that answers questiona about Wardley Mapping.

Protected by API Key

Headers

Authorization

required, string

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

Request Body

question

required, string

The question to ask the videos.

POST
/v1/querywardleyvideos
1
EXAMPLE BODY
{
  "question": "What is inertia?"
}

Analyse an Image of a Wardley Map

Analyse an image of a Wardley Map and provide an in-depth analysis.

Protected by API Key

Headers

Authorization

required, string

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

Request Body

file

optional, string

The Wardley Map image file to be analysed (JPEG or PNG).

POST
/v1/analyse-wardleymap-image
1