POST
/
v1
/
database
/
query
curl --request POST \
  --url https://api.roe-ai.com/v1/database/query/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "query": "<string>"
}'
[
  {
    "query_id": "123e4567-e89b-12d3-a456-426614174000",
    "query": "SELECT * FROM example",
    "summary": {
      "read_rows": 3,
      "read_bytes": 123,
      "written_rows": 0,
      "written_bytes": 0,
      "total_rows_to_read": 3,
      "result_rows": 3,
      "result_bytes": 123,
      "elapsed_ns": 1000000,
      "query_id": "123e4567-e89b-12d3-a456-426614174000"
    },
    "row_count": 3,
    "column_names": [
      "name",
      "file",
      "created_at"
    ],
    "column_types": [
      "String",
      "String",
      "DateTime"
    ],
    "result_rows": [
      [
        "example1.pdf",
        "file_123e4567-e89b-12d3-a456-426614174001",
        "2024-04-29 21:11:17+00:00"
      ],
      [
        "example2.png",
        "file_123e4567-e89b-12d3-a456-426614174002",
        "2024-04-29 21:11:18+00:00"
      ],
      [
        "example3.mp4",
        "file_123e4567-e89b-12d3-a456-426614174003",
        "2024-04-29 21:11:19+00:00"
      ]
    ],
    "start_timestamp": 1719852303.0115254,
    "end_timestamp": 1719852303.0204659
  }
]

Authorizations

​
Authorization
string
header
required

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

Body

​
query
string
required

Queries to run. Multiple queries can be separated by semicolons.

Minimum length: 1

Response

200
application/json
Query results
​
query_id
string
required

The query UUID.

​
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
array
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
required

The timestamp when the query started running.

​
end_timestamp
number
required

The timestamp when the query finished running.

Agent Job ResultRun Query Async