Save Chart from Chat

Persists a chart configuration produced by the chat endpoint’s generateChart tool so it can be added to dashboards. Pass the chartConfig object exactly as it appears in the chat stream’s tool result. Returns a chartId that can be passed directly to the add-charts-to-dashboard endpoint. Authenticate with a project user JWT (from the projects/user-token endpoint), a tenant JWT, or an Upsolve API key.

POST /v1/api/chart/save-from-chat

Save a chart generated by the AI chat agent

cURL

curl --request POST \
  --url https://api.upsolve.ai/v1/api/chart/save-from-chat \
  --header 'Content-Type: application/json' \
  --header 'authorization: <api-key>' \
  --data '
{
  "chartConfig": {
    "title": "<string>",
    "dimensions": [
      {
        "name": "<string>",
        "field": "<string>",
        "label": "<string>",
        "format": {
          "label": "<string>",
          "formatOptions": "<string>",
          "formatLocale": "<string>",
          "labelSuffix": "<string>",
          "labelPrefix": "<string>",
          "dateFormat": "<string>"
        }
      }
    ],
    "measures": [
      {
        "name": "<string>",
        "field": "<string>",
        "label": "<string>",
        "format": {
          "label": "<string>",
          "formatOptions": "<string>",
          "formatLocale": "<string>",
          "labelSuffix": "<string>",
          "labelPrefix": "<string>",
          "dateFormat": "<string>"
        }
      }
    ],
    "comparisons": [
      {
        "name": "<string>",
        "measure": "<string>",
        "customPeriod": 123
      }
    ],
    "mapConfig": {
      "latitude": "<string>",
      "longitude": "<string>"
    },
    "filters": [
      {
        "field": "<string>",
        "value": "<string>"
      }
    ],
    "havingFilters": [
      {
        "field": "<string>",
        "operator": "<string>",
        "value": "<string>",
        "aggregation": "<string>"
      }
    ],
    "settings": {
      "secondYAxis": true,
      "colors": [
        "<string>"
      ],
      "legend": true,
      "legendPosition": "bottom",
      "stacking": true,
      "showDataLabels": true,
      "enableLegendSlider": true,
      "showAxisLabels": true,
      "debug": true,
      "pageSize": 15,
      "sliceLimit": 7,
      "maxSeries": 20,
      "cornerRadius": 8,
      "requestedStyle": []
    },
    "orderBy": [
      {
        "field": "<string>"
      }
    ],
    "sqlOverride": "<string>"
  },
  "apiKey": "<string>",
  "organizationId": "<string>",
  "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sql": "<string>",
  "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "thumbnail": "<string>"
}
'

200

{
  "status": "success",
  "data": {
    "chartId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  }
}

Authorizations

authorization · string · header · required

Body

application/json

POST /v1/api/chart/save-from-chat Request body

chartConfig · object · required

The chart configuration exactly as returned by the chat endpoint's generateChart tool result (toolResult.result.chartConfig). Should include the sqlOverride field the agent bakes onto the config; if it doesn't, pass the query on the top-level sql field instead — without either the saved chart cannot query data when rendered on a dashboard.

Show child attributes

apiKey · string

Upsolve API key, generated under Account → Developer settings in the Upsolve Hub. Keys are user-scoped: pass organizationId alongside the key to select which org to act on.

Minimum string length: 1

organizationId · string

The ID of the organization. Required when using Supabase JWT authentication.

connectionId · string<uuid>

Explicit connection ID to associate with the chart. Overrides the connection resolved from workspaceId. When both are given, the connection must belong to the workspace's project. A resolvable connection (from either field) is required.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

sql · string

The chart's source SQL. Only needed when chartConfig.sqlOverride is absent — some generateChart tool-result shapes carry the query on the tool's sibling sql field instead of on the config. When both are present, chartConfig.sqlOverride wins.

workspaceId · string<uuid>

The workspace the chart was generated in (the same ID used to call the workspace chat endpoint). When provided, the chart is linked to the workspace's project and to the connection of its production version (the one chat queries), so it can be rendered on any dashboard.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

agentId · string<uuid>

Deprecated: pass workspaceId. The ID of a legacy agent, resolved to the workspace that replaced it. Ignored when workspaceId is given.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

name · string

Display name for the saved chart. Defaults to the chart config's title.

thumbnail · string

Optional thumbnail image (data URL) for the chart.

Response

200

application/json

POST /v1/api/chart/save-from-chat Positive response

status · string · required

Allowed value: "success"

data · object · required

Show child attributes