Wardley Mapping Developer Portal
Wardley Maps Crew API (ALPHA)

Tools

Endpoint:https://api.wardleymaps.ai

Tools for managing Wardley Maps

List GitHub Wardley Maps

GET
https://api.wardleymaps.ai
/v2/list-github-maps

Endpoint to list all Wardley Maps related to GitHub

List GitHub Wardley Maps › 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.

List GitHub Wardley Maps › Responses

string

Get GitHub Wardley Map Content

GET
https://api.wardleymaps.ai
/v2/get-github-map

Retrieve the content of a Wardley Map from GitHub.

Get GitHub Wardley Map Content › query Parameters

  • github_pathstring · required

    Path of the Wardley Map to retrieve.

Get GitHub Wardley Map Content › 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.

Get GitHub Wardley Map Content › Responses

Wardley Map Content

  • owmtextstring

    The text representation of the Wardley Map in OWM format

  • warningsstring[]

    List of warnings associated with the map

Knowledge Base