Execute SQL
POST /v1/databases/{name}/query
POST
/v1/databases/{name}/query
Costs 1 credit. Accepts one SQL statement with positional args. Execution is capped at 10 seconds and responses at 500 rows / 256 KB.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” name
required
string
Database name
Request Body required
Section titled “Request Body required ”object
sql
required
string
args
Array
Responses
Section titled “ Responses ”Query result.
object
columns
Array<string>
rows
Array<Array>
row_count
integer
truncated
boolean
ms
integer
Headers
Section titled “Headers ” X-Credits-Used
integer
Credits consumed.
X-Credits-Remaining
integer
Remaining credit balance.
Malformed request.
object
error
required
string
Example
invalid request field
Field that failed validation.
string
detail
string
hint
string
Missing or invalid API key.
object
error
required
string
Example
invalid request field
Field that failed validation.
string
detail
string
hint
string
Insufficient unreserved credits.
object
error
required
string
Example
insufficient credits required
required
integer
available
required
integer
Resource missing or not owned by this account.
object
error
required
string
Example
invalid request field
Field that failed validation.
string
detail
string
hint
string
Validation failed.
object
error
required
string
Example
invalid request field
Field that failed validation.
string
detail
string
hint
string
Feature or backing service is unavailable.
object
error
required
string
Example
invalid request field
Field that failed validation.
string
detail
string
hint
string