API Reference

Base URL (default local):

http://localhost:3488

Public Endpoints

Session-Protected Endpoints

All below require chui_session cookie.

Query

• POST /api/query/run
• POST /api/query/stream
• POST /api/query/format
• POST /api/query/explain
• POST /api/query/plan
• POST /api/query/profile
• GET /api/query/databases
• GET /api/query/tables
• GET /api/query/columns
• GET /api/query/data-types
• GET /api/query/clusters
• POST /api/query/schema/database
• POST /api/query/schema/database/drop
• POST /api/query/schema/table
• POST /api/query/schema/table/drop

Connections

• GET /api/connections
• POST /api/connections
• GET /api/connections/{id}
• DELETE /api/connections/{id}
• POST /api/connections/{id}/test
• GET /api/connections/{id}/token
• POST /api/connections/{id}/regenerate-token

Saved Queries

• GET /api/saved-queries
• POST /api/saved-queries
• GET /api/saved-queries/{id}
• PUT /api/saved-queries/{id}
• DELETE /api/saved-queries/{id}
• POST /api/saved-queries/{id}/duplicate

Pro API Groups

Pro endpoints are behind license middleware and include:

• /api/schedules
• /api/dashboards
• /api/brain
• /api/admin
• /api/governance

Example: Login + Run Query

# 1) Login
curl -i -X POST http://localhost:3488/api/auth/login \
  -H "Content-Type: application/json" \
  -d '{
    "username":"default",
    "password":"secret",
    "connectionId":"<connection-id>"
  }'

# 2) Reuse set-cookie value as chui_session
curl -X POST http://localhost:3488/api/query/run \
  -H "Content-Type: application/json" \
  -H "Cookie: chui_session=<session-token>" \
  -d '{"query":"SELECT version()"}'