/openloomi-api

name: openloomi-api
description: "openloomi HTTP API reference (local-first, served from the OpenLoomi Desktop app at http://localhost:3414). Use when working with openloomi backend routes — auth, AI, files, integrations, RAG, memory, Loop, pet, workspace, platform callbacks. Triggers: API endpoints, backend routes, /api/*, local API, port 3414, integrations REST, OAuth start, RAG search, loop state, memory search, pet state, audit logs"

> **Note:** If OpenLoomi readiness is unknown, use `openloomi-setup` first. If OpenLoomi Desktop is not installed, follow [Getting Started](https://openloomi.ai/docs/getting-started).

OpenLoomi API Documentation

API Modules

OpenLoomi ships a **local-first** HTTP API served from the desktop app (port `3414`, fallback `3515`). All auth, Memory, AI, RAG, Loop, and Audit data live in a local SQLite database — your data stays on your machine and the OpenLoomi app is the source of truth. The only externally-routed auth path is the **Composio OAuth broker** that backs the Slack, GitHub, Google, Notion, Linear, HubSpot, LinkedIn, Jira, and Asana Connectors (see `openloomi-connectors`).

The `remote-auth` prefix is historical — those routes once proxied to a cloud server; today they are the canonical local endpoints, and the Claude/Codex plugin bridge uses `/api/remote-auth/user` as a port-discovery + auth-handshake probe.

This reference covers **131 route handlers** under 36 top-level `/api/*` modules. Pair it with `openloomi-loop` (Loop state, decisions, channels, classifier rules, brief/wrap) and `openloomi-memory` (Memory search, KB, insights, entities, living connections) for the runtime surfaces used by Chat and Loop.

Functional Modules

| Module | Base Path | Routes | Description | |--------|-----------|--------|-------------| | **Auth** | `/api/auth/*`, `/api/remote-auth/*`, `/api/remote-feedback/*` | 6 | Guest session, token, user probe, feedback | | **AI** | `/api/ai/*` | 5 | Chat, images, audio, embeddings | | **Audit** | `/api/audit/*` | 1 | Audit log retrieval | | **Chat Insights** | `/api/chat-insights/*` | 1 | Per-chat insight records | | **Chronicle** | `/api/chronicle/*` | 7 | Meeting detection, analysis, memories | | **Contacts** | `/api/contacts/*` | 1 | Contact query | | **DB Init** | `/api/db/*` | 1 | Bootstrap database | | **Files** | `/api/files/*` | 8 | File storage, upload, download | | **Insight Tabs** | `/api/insight-tabs/*` | 3 | Tab CRUD + reorder | | **Integrations** | `/api/integrations/*` | 9 | OAuth + connected accounts | | **Listeners** | `/api/listeners/*` | 1 | Listener cleanup | | **LLM Usage** | `/api/llm/*` | 1 | Usage summary | | **Loop** | `/api/loop/*` | 24 | Attention loop, decisions, channels, classifier rules | | **Markmap** | `/api/markmap/*` | 1 | Markmap generation | | **Memory** | `/api/memory/*` | 2 | Memory search, raw messages | | **Messages** | `/api/messages/*` | 4 | Send, sync, status, raw | | **Native** | `/api/native/*` | 5 | Native agent operations, providers, skills | | **Pet** | `/api/pet/*` | 1 | Pet state mirror | | **Proxy** | `/api/proxy/*` | 2 | CSS/JS proxy | | **RAG** | `/api/rag/*` | 11 | Document upload, search, stats | | **Storage** | `/api/storage/*` | 4 | Disk usage, sessions, cleanup | | **Workspace** | `/api/workspace/*` | 11 | Artifacts, files, skills, previews |

Platform Callback Modules

Each integration platform has its own `/api/<platform>/*` module:

| Platform | Base Path | Routes | |----------|-----------|--------| | **Slack** | `/api/slack/*` | 2 | | **Discord** | `/api/discord/*` | 2 | | **Feishu (Lark)** | `/api/feishu/*` | 1 | | **DingTalk** | `/api/dingtalk/*` | 1 | | **QQ Bot** | `/api/qqbot/*` | 1 | | **Weixin (WeChat)** | `/api/weixin/*` | 4 | | **Telegram** | `/api/telegram/*` | 4 | | **WhatsApp** | `/api/whatsapp/*` | 2 | | **iMessage** | `/api/imessage/*` | 2 | | **HubSpot** | `/api/hubspot/*` | 1 | | **LinkedIn** | `/api/linkedin/*` | 1 | | **Notion** | `/api/notion/*` | 1 |

---

Endpoints Reference

Auth Module

| Method | Endpoint | Description | |--------|----------|-------------| | POST | `/api/auth/set-token` | Set auth token | | POST | `/api/auth/clear-auth-cookie` | Clear session | | POST | `/api/auth/token` | Issue session token | | POST | `/api/remote-auth/guest` | Create anonymous guest session | | GET | `/api/remote-auth/user` | Get current user (also used by plugin probe) | | PUT | `/api/remote-auth/user` | Update user info | | POST | `/api/remote-feedback` | Submit feedback |

Messages Module

| Method | Endpoint | Description | |--------|----------|-------------| | GET | `/api/messages` | List messages | | POST | `/api/messages` | Send message | | GET | `/api/messages/sync` | Sync messages | | GET | `/api/messages/check` | Check message status | | GET | `/api/messages/raw` | Get raw message |

Files Module

| Method | Endpoint | Description | |--------|----------|-------------| | GET | `/api/files/list` | List files | | GET | `/api/files/[id]` | Get file by ID | | GET | `/api/files/download` | Download file | | POST | `/api/files/upload` | Upload file | | POST | `/api/files/save` | Save file | | GET | `/api/files/usage` | Get storage usage | | GET | `/api/files/insights/download` | Download insights file | | POST | `/api/files/insights/save` | Save insights |

Storage Module

| Method | Endpoint | Description | |--------|----------|-------------| | GET | `/api/storage/disk-usage` | Get disk usage | | POST | `/api/storage/cleanup` | Cleanup storage | | GET | `/api/storage/sessions` | List sessions | | GET | `/api/storage/sessions/[taskId]` | Get session by task ID | | DELETE | `/api/storage/sessions/[taskId]` | Delete session |

Integrations Module

| Method | Endpoint | Description | |--------|----------|-------------| | GET | `/api/integrations/accounts` | List connected accounts | | GET | `/api/integrations/slack/oauth/start` | Start Slack OAuth | | GET | `/api/integrations/slack/oauth/exchange` | Exchan