Create Saved Query By Agent Endpoint

Generate a SQL request from a natural-language prompt using the dashboard agent pipeline.

Authorization

JwtAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

dashboard_id*Dashboard Id

Formatuuid

dataset_ids*array<>

prompt*Prompt

name?string|null

Response Body

`application/json`

curl -X POST "https://example.com/dashboards/saved-queries/agent" \  -H "Content-Type: application/json" \  -d '{    "dashboard_id": "6904cee6-5a01-4acf-92d9-7e185cd226de",    "dataset_ids": [      "7e733a3d-b346-4530-98b2-0edaf7a10014"    ],    "prompt": "string"  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "dashboard_id": "6904cee6-5a01-4acf-92d9-7e185cd226de",  "dataset_ids": [],  "name": "string",  "description": "string",  "query_type": "string",  "sql_query": "string",  "visual_query": {},  "is_active": true,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}