API ReferenceAPI Overview

API Overview

Chorum AI exposes a local REST API that allows you to interact with your memory system, manage projects, and send chat messages programmatically.

Base URL

By default, the API runs at:

http://localhost:3000/api

If you are running on a different port, adjust accordingly.


Authentication

Chorum’s API is intended for local use (e.g., by the CLI tool or local scripts).

For external access (e.g., from an IDE via MCP), we use API Tokens.

Header:

x-chorum-token: <your-api-token>

You can generate tokens in Settings → MCP Integration.


Response Format

All responses follow a standard JSON envelope:

Success:

{
  "data": { ... }
}

Error:

{
  "error": "Error message description",
  "code": "ERROR_CODE",
  "details": { ... }
}

Core Resources

ResourceDescriptionBase Endpoint
ProjectsManage project lifecycles/api/projects
MemoryRead/Write learnings/api/memory
ChatSend messages, delete history/api/chat
AgentsList available agents/api/agents