Skip to main content
POST
Query

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

orgId
string
required

The organization's id (UUID) or slug — either form is accepted.

projectId
string
required

The project's id (UUID) or slug — either form is accepted.

databaseId
string
required

The database's id (UUID), from databases.list.

Body

application/json
queryId
string
required

Caller-generated UUID used for cancellation.

sql
string
required

One SELECT, VALUES, SHOW, EXPLAIN, or WITH ... SELECT statement.

limit
integer

Maximum rows from 1 to 500. Defaults to 500.

Response

Bounded query results and measurements.

columns
object[]
required
rows
object[]
required
nextCursor
string | null
required
durationMs
number
required
rowCount
integer
required
bytes
integer
required
truncated
boolean
required

True when the server row or byte ceiling stopped collection.