Skip to main content
POST
Ask eng

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-correlation-id
string | null

Body

application/json
tables
string[]
required

List of the tables involved in the job or query. Format for a single table: .

(For example, public.employees).

prompt
string
required

The input question to generate the query.

job_name
string
required

Specifies the unique name of the job.

federated
boolean
required

Indicates whether the request selects one or more catalogs.

preview
boolean
required

Specifies whether the query requires a preview.

Response

Ask successful.

query
string
required

The interpreted SQL query generated from the prompt.

id
string<uuid> | null

A unique ID for the generated query.

data
DataResponse · object | null

The data returned as part of the query response, if applicable.

error
string | null

Error message if any issue occurred during query generation.