REST API Overview

The REST API exposes endpoints for query execution, result retrieval, and table/data management.

Detailed request/response schemas are available in Reference.

Endpoint groups

Service health

• GET /health: liveness status for the REST service.

Query execution and results

• POST /query: execute SQL (including AI operators) and materialize the result.
• POST /results/rows: fetch paginated rows from the latest materialized result.
• POST /results/download: download the full latest result as JSON, CSV, or ZIP.

Table discovery and inspection

• POST /tables: list visible tables in the configured database.
• POST /tables/{table_name}/schema: retrieve visible column metadata.
• POST /tables/{table_name}/preview: retrieve paginated preview rows.

Data lifecycle

• POST /upload: upload CSV or ZIP data into the configured database.
• DELETE /tables/{table_name}?confirm=true: drop a table with explicit confirmation.

Authentication and target database

• Authorization: Bearer <license_key> is required for most endpoints.
• Most requests include a db object describing target system and connection.
• Supported systems: duckdb (MotherDuck), postgres, mysql.