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

Set stream to true to receive text/event-stream frames. Each data: frame contains one JSON event object.

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: "item",
    task: "generate",
    stream: true,
    response_mode: "mixed",
    conversation_id: "fdce930b-4f6d-4d2b-8a43-7ea7d62457a2",
    input: [
      {
        type: "text",
        text: "Update the chart to compare monthly revenue and costs."
      },
      {
        type: "item",
        value: {
          type: "line-chart",
          slots: [

          ],
          filters: [

          ]
        }
      }
    ]
  }
);

Raw HTTP response body when stream is true . Each event is sent as a single data: <event JSON> Server-Sent Events frame, and the stream ends with data: [DONE] . Socket.IO clients receive the same JSON objects (without the data: prefix) on the aiprompt channel. The progress tree in this example is illustrative: step values, descriptions, and nesting vary by agent and workflow—render whatever tree the API sends and replace it on each progress event.

Example Response

200

400

500


data: {
  "type":"start",
  "conversation_id":"fdce930b-4f6d-4d2b-8a43-7ea7d62457a2",
  "user_message_id":"4a1289fb-2892-4fd6-8c3c-b0709a5ec2bb",
  "assistant_message_id":"40a580e6-75c2-434d-9dbd-4fa1b5d7791f"
}

data: {
  "type":"progress",
  "conversation_id":"fdce930b-4f6d-4d2b-8a43-7ea7d62457a2",
  "user_message_id":"4a1289fb-2892-4fd6-8c3c-b0709a5ec2bb",
  "assistant_message_id":"40a580e6-75c2-434d-9dbd-4fa1b5d7791f",
  "progress":{
    "id":"root",
    "step":"root",
    "status":"inProgress",
    "children":[
      {
        "id":"event-13-102",
        "step":"iqDatasets",
        "status":"success",
        "description":"Retrieving datasets",
        "children":[
          {
            "id":"event-14-696",
            "step":"iqDatasets.retrievingDatasets",
            "status":"success",
            "description":"Checking available datasets"
          },
          {
            "id":"event-15-403",
            "step":"iqDatasets.result",
            "status":"success",
            "description":"Shortlisted datasets to consider: {{datasets}}",
            "description_metadata":{
              "datasets":[
                "sales-dataset",
                "revenue-dataset"
              ]
            }
          }
        ]
      },
      {
        "id":"event-20-501",
        "step":"generateVisualization",
        "status":"inProgress",
        "description":"Generating visualization"
      }
    ]
  }
}

data: {
  "type":"text_start",
  "conversation_id":"fdce930b-4f6d-4d2b-8a43-7ea7d62457a2",
  "user_message_id":"4a1289fb-2892-4fd6-8c3c-b0709a5ec2bb",
  "assistant_message_id":"40a580e6-75c2-434d-9dbd-4fa1b5d7791f",
  "text_id":"40a580e6-75c2-434d-9dbd-4fa1b5d7791f:text"
}

data: {
  "type":"text_delta",
  "conversation_id":"fdce930b-4f6d-4d2b-8a43-7ea7d62457a2",
  "user_message_id":"4a1289fb-2892-4fd6-8c3c-b0709a5ec2bb",
  "assistant_message_id":"40a580e6-75c2-434d-9dbd-4fa1b5d7791f",
  "text_id":"40a580e6-75c2-434d-9dbd-4fa1b5d7791f:text",
  "delta":"Created a visualization."
}

data: {
  "type":"text_end",
  "conversation_id":"fdce930b-4f6d-4d2b-8a43-7ea7d62457a2",
  "user_message_id":"4a1289fb-2892-4fd6-8c3c-b0709a5ec2bb",
  "assistant_message_id":"40a580e6-75c2-434d-9dbd-4fa1b5d7791f",
  "text_id":"40a580e6-75c2-434d-9dbd-4fa1b5d7791f:text"
}

data: {
  "type":"asset_start",
  "conversation_id":"fdce930b-4f6d-4d2b-8a43-7ea7d62457a2",
  "user_message_id":"4a1289fb-2892-4fd6-8c3c-b0709a5ec2bb",
  "assistant_message_id":"40a580e6-75c2-434d-9dbd-4fa1b5d7791f",
  "asset_id":"7bfcf7ff-dcb2-4963-9e9b-0fe651a342af",
  "asset_type":"item"
}

data: {
  "type":"asset_delta",
  "conversation_id":"fdce930b-4f6d-4d2b-8a43-7ea7d62457a2",
  "user_message_id":"4a1289fb-2892-4fd6-8c3c-b0709a5ec2bb",
  "assistant_message_id":"40a580e6-75c2-434d-9dbd-4fa1b5d7791f",
  "asset_id":"7bfcf7ff-dcb2-4963-9e9b-0fe651a342af",
  "delta":{
    "type":"line-chart",
    "options":{...},
    "slots":[...],
    "filters":[...]
  }
}

data: {
  "type":"asset_end",
  "conversation_id":"fdce930b-4f6d-4d2b-8a43-7ea7d62457a2",
  "user_message_id":"4a1289fb-2892-4fd6-8c3c-b0709a5ec2bb",
  "assistant_message_id":"40a580e6-75c2-434d-9dbd-4fa1b5d7791f",
  "asset_id":"7bfcf7ff-dcb2-4963-9e9b-0fe651a342af"}

data: {
  "type":"finish",
  "conversation_id":"fdce930b-4f6d-4d2b-8a43-7ea7d62457a2",
  "user_message_id":"4a1289fb-2892-4fd6-8c3c-b0709a5ec2bb",
  "assistant_message_id":"40a580e6-75c2-434d-9dbd-4fa1b5d7791f",
  "result":{
    "conversation_id":"fdce930b-4f6d-4d2b-8a43-7ea7d62457a2",
    "user_message":{
      "id":"4a1289fb-2892-4fd6-8c3c-b0709a5ec2bb",
      "conversation_id":"fdce930b-4f6d-4d2b-8a43-7ea7d62457a2",
      "message":"Update the chart to compare monthly revenue and costs.",
      "role":"user",
      "agent":"item",
      "task":"generate",
      "locale_id":"en",
      "created_at":"2026-05-14T10:15:24.000Z",
      "updated_at":"2026-05-14T10:15:24.000Z",
      "aiMessageAssets":[
        {
          "id":"1c302f96-f568-46c2-a64f-9db4ae2d78eb",
          "message_id":"4a1289fb-2892-4fd6-8c3c-b0709a5ec2bb",
          "type":"item",
          "value":{
            "type":"line-chart",
            "options":{...},
            "slots":[...],
            "filters":[...]
          },
          "created_at":"2026-05-14T10:15:24.000Z",
          "updated_at":"2026-05-14T10:15:24.000Z"
        }
      ]
    },
    "assistant_message":{
      "id":"40a580e6-75c2-434d-9dbd-4fa1b5d7791f",
      "conversation_id":"fdce930b-4f6d-4d2b-8a43-7ea7d62457a2",
      "message":"Created a visualization.",
      "role":"assistant",
      "agent":null,
      "task":null,
      "locale_id":"en",
      "created_at":"2026-05-14T10:15:26.000Z",
      "updated_at":"2026-05-14T10:15:26.000Z",
      "aiMessageAssets":[
        {
          "id":"7bfcf7ff-dcb2-4963-9e9b-0fe651a342af",
          "message_id":"40a580e6-75c2-434d-9dbd-4fa1b5d7791f",
          "type":"item",
          "value":{
            "type":"line-chart",
            "options":{...},
            "slots":[...],
            "filters":[...]
          },
          "created_at":"2026-05-14T10:15:26.000Z",
          "updated_at":"2026-05-14T10:15:26.000Z"
        }
      ]
    }
  }
}

data: [DONE]