Run a SQL statement
curl --request POST \
--url https://api.gwenlake.com/v1/sql/statements \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"statement": "<string>",
"format": "pyarrow",
"mode": "duckdb",
"limit": 2
}
'import requests
url = "https://api.gwenlake.com/v1/sql/statements"
payload = {
"statement": "<string>",
"format": "pyarrow",
"mode": "duckdb",
"limit": 2
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({statement: '<string>', format: 'pyarrow', mode: 'duckdb', limit: 2})
};
fetch('https://api.gwenlake.com/v1/sql/statements', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.gwenlake.com/v1/sql/statements",
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([
'statement' => '<string>',
'format' => 'pyarrow',
'mode' => 'duckdb',
'limit' => 2
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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 := "https://api.gwenlake.com/v1/sql/statements"
payload := strings.NewReader("{\n \"statement\": \"<string>\",\n \"format\": \"pyarrow\",\n \"mode\": \"duckdb\",\n \"limit\": 2\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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("https://api.gwenlake.com/v1/sql/statements")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"statement\": \"<string>\",\n \"format\": \"pyarrow\",\n \"mode\": \"duckdb\",\n \"limit\": 2\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gwenlake.com/v1/sql/statements")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"statement\": \"<string>\",\n \"format\": \"pyarrow\",\n \"mode\": \"duckdb\",\n \"limit\": 2\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Run a SQL statement
Run a read-only statement. Without a LIMIT of its own, the result is
capped (1000 rows unless limit says otherwise); a cut is reported — in
the JSON body (truncated, limit) and, for every format, in the
X-Gwenlake-Truncated / X-Gwenlake-Row-Limit headers — so a client
reading a whole table can tell it must page.
POST
/
sql
/
statements
Run a SQL statement
curl --request POST \
--url https://api.gwenlake.com/v1/sql/statements \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"statement": "<string>",
"format": "pyarrow",
"mode": "duckdb",
"limit": 2
}
'import requests
url = "https://api.gwenlake.com/v1/sql/statements"
payload = {
"statement": "<string>",
"format": "pyarrow",
"mode": "duckdb",
"limit": 2
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({statement: '<string>', format: 'pyarrow', mode: 'duckdb', limit: 2})
};
fetch('https://api.gwenlake.com/v1/sql/statements', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.gwenlake.com/v1/sql/statements",
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([
'statement' => '<string>',
'format' => 'pyarrow',
'mode' => 'duckdb',
'limit' => 2
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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 := "https://api.gwenlake.com/v1/sql/statements"
payload := strings.NewReader("{\n \"statement\": \"<string>\",\n \"format\": \"pyarrow\",\n \"mode\": \"duckdb\",\n \"limit\": 2\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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("https://api.gwenlake.com/v1/sql/statements")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"statement\": \"<string>\",\n \"format\": \"pyarrow\",\n \"mode\": \"duckdb\",\n \"limit\": 2\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gwenlake.com/v1/sql/statements")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"statement\": \"<string>\",\n \"format\": \"pyarrow\",\n \"mode\": \"duckdb\",\n \"limit\": 2\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Your Gwenlake API key, sent as Authorization: Bearer <key>.
Headers
Body
application/json
POST /sql/statements — run a SQL statement live (ad hoc, nothing
stored). The stored form is the sql-query resource (/sql/queries,
app/schemas/sql_queries.py).
Response
Successful Response