Api reference DuckDB Query Run a DuckDB query against registered sources Executes a single read-only DuckDB SELECT or WITH statement after registering named sources. S3 and local file sources are supported now; PostgreSQL sources are reserved for future support.
POST /api/v1/duckdb/queryTest
Executes a single read-only DuckDB SELECT or WITH statement after registering named sources. S3 and local file sources are supported now; PostgreSQL sources are reserved for future support.
TypeScript Definitions
Use the request body type in TypeScript.
cURL
JavaScript
Go
Python
Java
C#curl -X POST "https://loading/api/v1/duckdb/query" \ -H "Content-Type: application/json" \ -d '{ "sql": "SELECT category, count(*) AS items FROM products GROUP BY category ORDER BY items DESC LIMIT 10", "sources": [ { "kind": "s3", "name": "products", "key": "workspaces/ws_demo/imports/products.parquet", "format": "parquet" } ] }'
200 400 401 403 500
{ "sql" : "SELECT category, count(*) AS items FROM products GROUP BY category ORDER BY items DESC LIMIT 10" , "sourceNames" : [ "products" ], "table" : { "columns" : [ "category" , "items" ], "rows" : [ [ "fruit" , "12" ], [ "vegetables" , "8" ] ] }, "records" : [ { "category" : "fruit" , "items" : 12 }, { "category" : "vegetables" , "items" : 8 } ], "rowCount" : 2 , "executionTimeMs" : 18 } { "issues" : [ { "_tag" : "Pointer" , "path" : [ "string" ], "message" : "string" } ], "message" : "string" , "_tag" : "HttpApiDecodeError" } { "code" : "authentication_required" , "message" : "Authentication required. Send Authorization: Bearer <api-key>, x-api-key, or a signed-in session." } { "code" : "insufficient_permissions" , "message" : "This API key does not have data.read permission." , "details" : { "requiredPermission" : "data.read" } } { "code" : "internal_error" , "message" : "An unexpected server error occurred." } 