Authentication
You need to sign in to view and manage your API credentials through our secure authentication system. After signing in, you can view and manage your API credentials from your account dashboard. These credentials must be included with each API request to authenticate your access. Security best practices: never share your API credentials, rotate your keys regularly, and use environment variables to store them securely in your applications.
Map Generation
Create a Wardley Map from text using the /v2/generate-mapfromtext endpoint. Create a Wardley Map using an existing map ID with the /v2/generate-mapfromid endpoint. Retrieve any warnings for your map using the /v2/get-owm-warnings endpoint.
Component Management
Get All Components
Retrieve all components of a specific Wardley Map using the /v2/get-owm-components endpoint. This provides a comprehensive view of all elements in your map.
Get Single Component
Retrieve detailed information about a specific component using the /v2/get-owm-component endpoint. Search for specific components within a map using the /v2/search-owm-components endpoint.
Map Structure Elements
Anchors and Notes
Retrieve user needs and starting points with the /v2/get-owm-anchors endpoint. Get explanatory notes attached to your map with the /v2/get-owm-notes endpoint.
Pipelines and Annotations
Access pipeline components showing industrialisation with the /v2/get-owm-pipelines endpoint. Retrieve map annotations using the /v2/get-owm-annotations endpoint.
Map Text Retrieval
Request the map text representation using the API. The API returns the structured text representation of your map that can be edited or saved. Use the retrieved text to modify your map or share it with others for collaboration.
API Base URL
Base URL
All API requests must be made to: https://api.wardleymaps.ai
Request Method
All endpoints use the POST method for request submission
Data Format
Requests and responses are formatted in JSON
Getting Started
Sign in at api.wardleymaps.ai to get your API credentials. Review the full API documentation at api.wardleymaps.ai/docs. Try generating a map from text using the /v2/generate-mapfromtext endpoint. Then integrate the API into your application to create and manage Wardley Maps.