Skip to main content

Does Heptabase provide a public API?

Heptabase does not currently offer a public REST API that covers all app operations. If you want another tool or AI agent to access and work with Heptabase, use Heptabase MCP or the Heptabase CLI.

​

​

​

Connect an external AI service with MCP

Heptabase MCP lets compatible AI services search, read, create, and update supported content in your Heptabase Space.

​

If you use ChatGPT, Codex, Claude, or Claude Code, the simplest option is to install the official Heptabase plugin: see Use Heptabase with ChatGPT and Codex or Use Heptabase with Claude and Claude Code. To connect another MCP-compatible service, see Heptabase MCP.

​

​

​

Work through the desktop app with the CLI

Heptabase CLI lets terminal tools and AI coding agents work through the running Heptabase desktop app.

​

MCP and the CLI can do most of the same things. To compare them, see Heptabase MCP and CLI: what's the difference?. See Heptabase CLI for setup and supported commands.

​

​

​

Supported integration interfaces

MCP and the CLI are the supported ways to integrate with Heptabase. Internal endpoints and direct access to app databases are not supported integration interfaces.

​

If MCP or the CLI does not support an operation you need, contact Heptabase support and describe your use case.

Did this answer your question?