Skip to main content
POST
/
v1
/
database
/
query
curl --request POST \
  --url "https://api.roe-ai.com/v1/database/query/?organization_id=YOUR_ORG_ID" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "query": "SELECT * FROM my_table LIMIT 10"
  }'

[
  {
    "query": "SELECT * FROM users LIMIT 10",
    "worksheet_id": "123e4567-e89b-12d3-a456-426614174000",
    "use_admin": false,
    "organization_id": "123e4567-e89b-12d3-a456-426614174000"
  }
]
curl --request POST \
  --url "https://api.roe-ai.com/v1/database/query/?organization_id=YOUR_ORG_ID" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "query": "SELECT * FROM my_table LIMIT 10"
  }'

Query Parameters

​
organization_id
string<uuid>

Organization ID. This is required for access control. It can be provided via query or request body depending on the endpoint.

Body

​
query
string
required

SQL query to execute

Minimum string length: 1
​
worksheet_id
string<uuid>

Optional worksheet ID

​
use_admin
boolean
default:false

Use admin privileges

​
organization_id
string<uuid>

Organization ID

Response

​
query
string
required

The query that was run.

​
summary
object
required

The summary of the query results.

​
row_count
integer
required

The number of rows returned by the query.

​
column_names
string[]
required

A list of strings representing the column names

​
column_types
string[]
required

A list of strings representing the column types

​
result_rows
string[][]
required

A matrix of the data returned in the form of a Sequence of rows, with each row element being a sequence of column values.

​
start_timestamp
number<double>
required

The timestamp when the query started running.

​
end_timestamp
number<double>
required

The timestamp when the query finished running.

​
query_id
string

The query UUID.