Wardley Maps Crew API (ALPHA)

Knowledge Base

Endpoint:https://api.wardleymaps.ai

Operations related to the Wardley Mapping knowledge base

Query the Wardley Mapping Book

POST

https://api.wardleymaps.ai

/v1/querywardleybook

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

Query the Wardley Mapping Book › 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.

Query the Wardley Mapping Book › Request Body

unique_uuidstring · required
Generate a unique UUID identifier for this conversation with the user
querystring · required
The query to be processed about Wardley Mapping

Query the Wardley Mapping Book › Responses

Successful response

answerstring
The response generated by the chatbot
source_documentsobject[]

Query the Wardley Mapping Diagrams

POST

https://api.wardleymaps.ai

/v1/querywardleydiagrams

Ask a question about Wardley Mapping diagrams within the book

Query the Wardley Mapping Diagrams › 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.

Query the Wardley Mapping Diagrams › Request Body

unique_uuidstring · required
Generate a unique UUID identifier for this conversation with the user
querystring · required
The query to be processed about Wardley Mapping

Query the Wardley Mapping Diagrams › Responses

Successful response

answerstring
The response generated by the chatbot
source_documentsobject[]

Query the Wardley Mapping Videos

POST

https://api.wardleymaps.ai

/v1/querywardleyvideos

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

Query the Wardley Mapping Videos › 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.

Query the Wardley Mapping Videos › Request Body

questionstring · required
The question to ask the videos.

Query the Wardley Mapping Videos › Responses

Successful response

answerstring
sourcestring
titlestring
authorstring
source_videostring
start_timeinteger
view_countinteger
like_countinteger
dislike_countinteger
upload_datestring
average_ratingnumber
descriptionstring
contentstring

Analyse an Image of a Wardley Map

POST

https://api.wardleymaps.ai

/v1/analyse-wardleymap-image

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

Analyse an Image 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.

Analyse an Image of a Wardley Map › Request Body

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

Analyse an Image of a Wardley Map › Responses

Rate Limiting Response

typestring · required
A URI reference that identifies the problem.
titlestring · required
A short, human-readable summary of the problem.
statusnumber · required
The HTTP status code.

instancestring

Conversions Tools