POST
/
v1
/
database
/
query
/
csharp
using System;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Text.Json;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        string token = "YOUR_API_TOKEN"; // Replace with your API token
        string url = "https://api.roe-ai.com/v1/database/query/";
        
        // Create payload
        var payload = new
        {
            query = "YOUR_SQL_QUERY", // Replace with your SQL query
            organization_id = "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        };
        
        string jsonPayload = JsonSerializer.Serialize(payload);
        
        using var client = new HttpClient();
        client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", token);
        
        // Create request content
        var content = new StringContent(jsonPayload, Encoding.UTF8, "application/json");
        
        // Send request
        HttpResponseMessage response = await client.PostAsync(url, content);
        string responseBody = await response.Content.ReadAsStringAsync();
        
        Console.WriteLine(responseBody);
    }
}
[
  {
    "query": "SELECT * FROM users LIMIT 10",
    "worksheet_id": "123e4567-e89b-12d3-a456-426614174000",
    "use_admin": false,
    "organization_id": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Authorizations

Authorization
string
header
required

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

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

The timestamp when the query started running.

end_timestamp
number
required

The timestamp when the query finished running.

query_id
string

The query UUID.