Create AIPrompt

LLM-friendly URL

POST

https://api.luzmo.com/0.1.0/aiprompt

API call form

Examples

List of examples

Generate a chart with the item agent, limited to one dataset
Stream a prompt over SSE using item context
Answer with the analyst agent using dashboard context
Generate a dashboard with the dashboard agent
Add a detail table to an existing dashboard
Run a saved Agent
Run the analyst agent with a saved Agent

Description

Pass the current dashboard state so the analyst grounds its answer in the charts, active filters, and dashboard metadata the user is viewing.

Install

npm install @luzmo/nodejs-sdk

Example Request

Shell

Node

Java

.NET

Python

PHP

import Luzmo from '@luzmo/nodejs-sdk';
const client = new Luzmo({
  api_key: '<your Luzmo API key>',
  api_token: '<your Luzmo API token>',
  host: 'https://api.luzmo.com'
});


const response = await client.create('aiprompt',
  {
    agent: "analyst",
    task: "generate",
    response_mode: "text",
    text_format: "markdown",
    locale_id: "en",
    input: [
      {
        type: "text",
        text: "Why did revenue drop compared to last quarter?"
      },
      {
        type: "dashboard",
        value: {
          currentScreenMode: "desktop",
          meta: {
            title: "Sales overview",
            description: "Quarterly revenue and pipeline KPIs for the EMEA region."
          },
          views: [
            {
              screenModus: "desktop",
              items: [
                {
                  id: "a1b2c3d4-e5f6-7890-abcd-ef0123456789",
                  type: "line-chart",
                  options: {
                    title: {
                      en: "Revenue by quarter"
                    }
                  },
                  slots: [
                    {
                      name: "x-axis",
                      content: [
                        {
                          label: {
                            en: "Quarter"
                          }
                        }
                      ]
                    },
                    {
                      name: "measure",
                      content: [
                        {
                          label: {
                            en: "Revenue"
                          }
                        }
                      ]
                    }
                  ],
                  filters: [

                  ]
                }
              ]
            }
          ],
          runtimeFilters: [
            {
              condition: "and",
              origin: "global",
              datasetId: "1ecf1fd1-cf74-47f8-9f73-aed6ea6ad44a",
              filters: [
                {
                  expression: "? in ?",
                  parameters: [
                    {
                      datasetId: "1ecf1fd1-cf74-47f8-9f73-aed6ea6ad44a",
                      columnId: "9b1c2d3e-4f56-7890-abcd-ef0123456789"
                    },
                    [
                      "EMEA"
                    ]
                  ]
                }
              ]
            }
          ]
        }
      },
      {
        type: "dataset",
        id: "1ecf1fd1-cf74-47f8-9f73-aed6ea6ad44a"
      }
    ]
  }
);

Example Response

200

400

500

{
  "conversation_id": "c1d2e3f4-a5b6-4788-9a0b-1c2d3e4f5a6b",
  "user_message": {
    "id": "d2e3f4a5-b6c7-4899-a0b1-2c3d4e5f6a7b",
    "conversation_id": "c1d2e3f4-a5b6-4788-9a0b-1c2d3e4f5a6b",
    "message": "Why did revenue drop compared to last quarter?",
    "role": "user",
    "agent": "analyst",
    "task": "generate",
    "locale_id": "en",
    "created_at": "2026-05-14T10:30:11.000Z",
    "updated_at": "2026-05-14T10:30:11.000Z",
    "aiMessageAssets": []
  },
  "assistant_message": {
    "id": "e3f4a5b6-c7d8-490a-b1c2-3d4e5f6a7b8c",
    "conversation_id": "c1d2e3f4-a5b6-4788-9a0b-1c2d3e4f5a6b",
    "message": "For the EMEA region, revenue is down 12% quarter over quarter, driven mainly by a drop in new deals in the Enterprise segment. Existing-customer revenue stayed flat.",
    "role": "assistant",
    "agent": null,
    "task": null,
    "locale_id": "en",
    "created_at": "2026-05-14T10:30:14.000Z",
    "updated_at": "2026-05-14T10:30:14.000Z",
    "aiMessageAssets": []
  }
}