Combined
API referenceEndpointsQuery

Query Sql

Execute one bounded, read-only SELECT over granted catalog relations. Use positional parameters for values and maxRows to bound output. An optional Idempotency-Key can recover the identical query after an ambiguous transport failure.

POST
/v1/sql

Execute one bounded, read-only SELECT over granted catalog relations. Use positional parameters for values and maxRows to bound output. An optional Idempotency-Key can recover the identical query after an ambiguous transport failure.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Header Parameters

Idempotency-Key?string

Optional recovery key. Reuse it only with the identical SQL request body.

Length8 <= length <= 200

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/sql" \  -H "Idempotency-Key: operation-20260816-001" \  -H "Content-Type: application/json" \  -d '{    "accountId": "00000000-0000-4000-8000-000000000001",    "sql": "SELECT channel_name, COUNT(*) AS messages FROM slack_messages WHERE sent_at >= ? GROUP BY channel_name ORDER BY messages DESC LIMIT 20",    "parameters": [      "2026-08-01T00:00:00Z"    ],    "maxRows": 20  }'
{  "data": {    "receiptId": "4937ce52-e283-4321-b00f-c29b6dd5d0e9",    "columns": [      {        "name": "string",        "type": "string"      }    ],    "rows": [      {        "property1": null,        "property2": null      }    ],    "rowCount": 0,    "truncated": true,    "durationMs": 0,    "estimatedInputBytes": 0,    "grantVersion": -9007199254740991  },  "correlationId": "string"}