HomeGuidesAPI ReferenceRelease notes
Log In
API Reference

Run Nl Query

post
https://api.superwise.ai/v1/datasets/nl-query

Convert a natural language request to SQL and execute it against datasets.

  • query (str): Required. Plain English description of the data you want.
  • dataset_ids (list[str]): Required. Dataset IDs to scope the query.
  • generate_only (bool): Optional. When True, return generated SQL + sqlglot validation without executing.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≥ 1

Natural language description of the data you want

dataset_ids
array of strings
required
length ≥ 1

Dataset IDs to scope the query. Only these datasets are included in the context sent to the model.

Dataset Ids*
boolean
Defaults to false

When True, return the generated SQL query without executing it.

enum

Fetch and base64-embed image columns at this thumbnail size

Responses

400

Bad Request

422

Unprocessable Entity

Updated 29 days ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 29 days ago