Database
Query Result
GET
/
v1
/
database
/
query
/
{query_task_id}
/
result
curl --request GET \
--url https://api.roe-ai.com/v1/database/query/{query_task_id}/result/ \
--header 'Authorization: Bearer <token>'
{
"query_task_id": "123e4567-e89b-12d3-a456-426614174000",
"results": [
{
"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
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Response
200
application/json
Query results
The query task UUID.
The status of the query task.
The results of the query.
The query UUID.
The query that was run.
The summary of the query results.
The number of rows returned by the query.
A list of strings representing the column names
A list of strings representing the column types
A matrix of the data returned in the form of a Sequence of rows, with each row element being a sequence of column values.
The timestamp when the query started running.
The timestamp when the query finished running.
An error message if the query failed.
curl --request GET \
--url https://api.roe-ai.com/v1/database/query/{query_task_id}/result/ \
--header 'Authorization: Bearer <token>'
{
"query_task_id": "123e4567-e89b-12d3-a456-426614174000",
"results": [
{
"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
}
]
}