Create AI Chart

LLM-friendly URL
POST
https://api.luzmo.com/0.1.0/aichart
API call form
Examples

Retrieve AI-generated chart suggestions based on the structure of a specified dataset and optionally a user-specified prompt.

To use AI-generated charts, an Organization Owner must enable the experimental feature in the Organization profile. When using Luzmo AI, we may send dataset metadata like column names and descriptions to OpenAI. Row-level data from your sets is never shared.

Find potential use cases on our blog .

The chart generator can currently create charts of the following types: area-chart , bar-chart , bubble-chart , circle-pack-chart , column-chart , donut-chart , line-chart , evolution-number , pivot-table , regular-table , scatter-plot , sunburst-chart and treemap-chart and filters of the following types: date-filter , dropdown-filter , slicer-filter and slider-filter . The generator can suggest chart types automatically based on the context or you can guide it to a particular type. Chart option support is continuously expanding.

Parameters
Expand all Reset
properties *OBJECTrequired
dataset_id *UUIDrequired
type *ENUMrequired
question STRING
message_history ARRAY[STRING]
Can be executed by:
Logged-in User
Can be associated to:
Create Data
Did this page help you?
Yes No
Language
Shell
Node
Java
.NET
Python
PHP
Install
npm install @luzmo/nodejs-sdk
Example Request 
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('aichart',
  {
    type: "generate-chart",
    dataset_id: "<dataset ID>",
    question: "Visualize burrito cheesyness by recipe"
  }
);
You are not authenticated.
Log in to try
Example Response
200
400
500
{
  "generatedChart": {
    "type": "bar-chart",
    "position": {
      "sizeX": 24,
      "sizeY": 28,
      "row": 0,
      "col": 0
    },
    "title": {},
    "options": {
      "title": {
        "en": "Cheesyness by Recipe"
      }
    },
    "content": {},
    "slots": [
      {
        "name": "y-axis",
        "content": [
          {
            "type": "numeric",
            "format": ",.2f",
            "label": "cheesyness",
            "columnId": "99909a5d-aa8f-405b-8325-2d30b67af583",
            "datasetId": "d75f3d79-ae27-4007-8653-19b22db79bbd"
          }
        ]
      },
      {
        "name": "measure",
        "content": []
      },
      {
        "name": "legend",
        "content": [
          {
            "type": "hierarchy",
            "label": "recipe",
            "columnId": "ec281a85-7def-4603-819f-408835780aa9",
            "datasetId": "d75f3d79-ae27-4007-8653-19b22db79bbd"
          }
        ]
      }
    ],
    "aichartId": "303768d2-ff51-4e11-82c8-dffc8691ff48"
  },
  "question": "Visualize burrito cheesyness by recipe",
  "functionCall": "createBarChart",
  "functionResponse": {
    "title": "Cheesyness by Recipe",
    "s__y-axis": [
      {
        "id": "0"
      }
    ],
    "s__measure": [],
    "s__legend": [
      {
        "id": "10"
      }
    ]
  }
}