Insights AI

Insights AI lets you query your WalkMe data using natural language, programmatically. Send a prompt describing what you want to know, and Insights AI returns an answer generated from your systems' data — optionally scoped to specific systems and carried across a multi-turn session.

Prompt

POST

https://api.walkme.com/public/v1/data-platform/data-ai/api/prompt

Send a natural-language prompt to Insights AI and receive a generated response, with optional context to scope the query and maintain session state across follow-up requests.

Headers

  • Content-Type (String): application/json
  • Authorization (String): Bearer

Body params

  • message (String, required): Prompt message
  • context.timezone (String, optional): Optional timezone
  • context.systemGuidsFilter (Array[String], optional): Force context on a specific set of systems. Retrieve system GUIDs from the Get All Systems endpoint.
  • context.sessionId (optional): On the first request to Insights AI, you will receive a session identifier in the response. You can use this session ID in your followup questions in order to keep context throughout the session. A single API key can have multiple session IDs.
{
   "message": "Help me get started",
   "context": {
       "timezone": "America/New York",
       "systemGuidsFilter": [
           "3bv8py6bgtlea1b5ps88d9g63wr0icr4"
       ],
       "sessionId": "e04de952-bb29-4afa-8dd1-22d7e1a016a9"
   }
}
{
    "content": "I can help you analyze your WalkMe data by querying usage statistics, user trends, and system configurations. Whether you're looking for the most popular content, session durations, or a deeper understanding of user behavior",
    "requestId": "aa883c45-1ff3-499d-93d6-76f3169730f1",
    "sessionId": "844cda60-dc30-4fe0-b36d-c01cf640014a"
}

MCP

Insights AI is also available as an MCP server, so MCP-compatible clients can connect directly and call it as a tool.

https://api.walkme.com/public/v1/data-platform/data-ai/mcp

Authenticate using the same bearer token as the REST API, passed as a header.

{
 "mcpServers": {
   "insights-ai": {
     "url": "https://api.walkme.com/public/v1/data-platform/data-ai/mcp",
     "headers": {
       "Authorization": "Bearer $TOKEN"
     }
   }
 }
}