EddytorDocs & API

08 · Integrations & Automation

Drive Eddytor from outside - CLI, REST, Flight SQL, and MCP.

Eddytor is API-first, so everything is scriptable. Pick the interface that fits the job.

The interfaces

  • eddytor CLI - the terminal/scripting interface; verb-first grammar, --json for CI.
  • REST API - the control plane for apps; OpenAPI at /spec, a unified error envelope.
  • Flight SQL endpoint - high-throughput Arrow reads for exports and BI (port 8082).
  • MCP clients - drive Eddytor from Claude Desktop, Cursor, and other MCP clients.
  • Scripting with API keys - headless auth patterns for automation.

The read/write boundary (read this first)

Eddytor deliberately splits where operations go:

OperationUse
Control plane + small readsREST (/api/v1) or the CLI
Bulk / analytical readsFlight SQL (Arrow, port 8082)
Row DML (insert/update/merge/delete)gRPC - via the CLI, an SDK, or MCP write tools. There is no REST merge endpoint.

Good to know

Machines use API keys; humans use eddytor login. Access tokens are short-lived (~15 min) - for automation use a non-expiring API key.

Next

On this page