Skip to main content
POST
/
api
/
query
/
suggest
Generates suggested questions
curl --request POST \
  --url https://api.example.com/api/query/suggest \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domain": "<string>"
}
'
[
  {
    "suggestion": "<string>",
    "description": "<string>",
    "sql": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
]

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
​
domain
string
required

The domain or data context that suggestions are generated for.

Response

Suggestion successfully requested.

​
suggestion
string
required

A short title or summary of the AI-generated suggestion.

​
description
string
required

A detailed explanation or reasoning for the generated suggestion.

​
sql
string
required

The SQL query generated by the AI based on the suggestion.

​
id
string<uuid> | null

A unique identifier for the AI-generated suggestion.