Natural-language query (AI)
curl --request POST \
--url http://localhost:8080/api/v1/query/natural \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"question": "<string>",
"table": "<string>",
"database": "datris",
"schema": "public",
"limit": 100
}
'import requests
url = "http://localhost:8080/api/v1/query/natural"
payload = {
"question": "<string>",
"table": "<string>",
"database": "datris",
"schema": "public",
"limit": 100
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
question: '<string>',
table: '<string>',
database: 'datris',
schema: 'public',
limit: 100
})
};
fetch('http://localhost:8080/api/v1/query/natural', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/api/v1/query/natural",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'question' => '<string>',
'table' => '<string>',
'database' => 'datris',
'schema' => 'public',
'limit' => 100
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:8080/api/v1/query/natural"
payload := strings.NewReader("{\n \"question\": \"<string>\",\n \"table\": \"<string>\",\n \"database\": \"datris\",\n \"schema\": \"public\",\n \"limit\": 100\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:8080/api/v1/query/natural")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"question\": \"<string>\",\n \"table\": \"<string>\",\n \"database\": \"datris\",\n \"schema\": \"public\",\n \"limit\": 100\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/query/natural")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"question\": \"<string>\",\n \"table\": \"<string>\",\n \"database\": \"datris\",\n \"schema\": \"public\",\n \"limit\": 100\n}"
response = http.request(request)
puts response.read_body{
"question": "<string>",
"sql": "<string>",
"results": [
{}
],
"count": 123
}Query
Natural-language query (AI)
Ask a question in plain English against a PostgreSQL table. The server reads the table’s columns, uses AI to generate a SQL SELECT, executes it, and returns both the SQL and the results.
POST
/
api
/
v1
/
query
/
natural
Natural-language query (AI)
curl --request POST \
--url http://localhost:8080/api/v1/query/natural \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"question": "<string>",
"table": "<string>",
"database": "datris",
"schema": "public",
"limit": 100
}
'import requests
url = "http://localhost:8080/api/v1/query/natural"
payload = {
"question": "<string>",
"table": "<string>",
"database": "datris",
"schema": "public",
"limit": 100
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
question: '<string>',
table: '<string>',
database: 'datris',
schema: 'public',
limit: 100
})
};
fetch('http://localhost:8080/api/v1/query/natural', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/api/v1/query/natural",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'question' => '<string>',
'table' => '<string>',
'database' => 'datris',
'schema' => 'public',
'limit' => 100
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:8080/api/v1/query/natural"
payload := strings.NewReader("{\n \"question\": \"<string>\",\n \"table\": \"<string>\",\n \"database\": \"datris\",\n \"schema\": \"public\",\n \"limit\": 100\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:8080/api/v1/query/natural")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"question\": \"<string>\",\n \"table\": \"<string>\",\n \"database\": \"datris\",\n \"schema\": \"public\",\n \"limit\": 100\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/query/natural")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"question\": \"<string>\",\n \"table\": \"<string>\",\n \"database\": \"datris\",\n \"schema\": \"public\",\n \"limit\": 100\n}"
response = http.request(request)
puts response.read_body{
"question": "<string>",
"sql": "<string>",
"results": [
{}
],
"count": 123
}Authorizations
Optional API key for authentication (enabled via application.yaml)
Body
application/json
⌘I
