API Reference · Live Catalog

One source of truth for API readiness.

This page is generated from the same typed endpoint catalog as the OpenAPI document. Status changes appear here automatically when an operation moves between GA, Preview, and Planned.

Build on AicooOverview 1. Intro + API Key 2. Aicoo Agent 3. Aicoo OS + Tools 4. OAuth / OIDC

Build on SharedOSAgent Network API

ReferenceAPI Status OpenAPI 3.0 JSON

GA113

Generally available

Live in production and safe to build on.

Preview — design partners4

Design-partner preview

Callable for enabled partners; the contract may change.

Planned — contract preview, not yet callable1

Planned contract

Published for feedback and not yet callable.

OpenAPI 3.0

Import the same catalog into Postman

Every operation carries standard track, group, and status tags plus explicit Aicoo status extensions.

Open openapi.json

Track 1

Build on Aicoo

56 operations · 56 GA · 0 Preview · 0 Planned

Method	Path	Group	Status
POST	`/api/v1/init` Initialize Workspace	Aicoo OS + Tools	GA
POST	`/api/v1/chat` Agent Chat	Aicoo Agent	GA
POST	`/api/v1/briefing` Daily Briefing	Aicoo Agent	GA
POST	`/api/v1/briefing/strategies` COO Strategies	Aicoo Agent	GA
POST	`/api/v1/briefing/matrix` Eisenhower Matrix	Aicoo Agent	GA
GET	`/api/v1/briefings` Briefing History	Aicoo Agent	GA
GET	`/api/v1/notes/summary` Notes Summary	Aicoo Agent	GA
GET	`/api/v1/os` OS Endpoint Index	Aicoo OS + Tools	GA
POST	`/api/v1/accumulate` Accumulate Context	Aicoo OS + Tools	GA
GET	`/api/v1/os/status` Workspace Status	Aicoo OS + Tools	GA
GET	`/api/v1/os/folders` List Folders	Aicoo OS + Tools	GA
POST	`/api/v1/os/folders` Create Folder	Aicoo OS + Tools	GA
GET	`/api/v1/os/notes` List Notes	Aicoo OS + Tools	GA
POST	`/api/v1/os/notes` Create Note	Aicoo OS + Tools	GA
POST	`/api/v1/os/notes/search` Search Notes	Aicoo OS + Tools	GA
POST	`/api/v1/os/notes/grep` Grep Notes	Aicoo OS + Tools	GA
GET	`/api/v1/os/todos` Search Todos	Aicoo OS + Tools	GA
POST	`/api/v1/os/todos` Create Todo	Aicoo OS + Tools	GA
GET	`/api/v1/tools` Discover Tools	Aicoo OS + Tools	GA
POST	`/api/v1/tools` Execute Tool	Aicoo OS + Tools	GA
GET	`/api/v1/os/network/conversations` List Guest Conversations	Aicoo OS + Tools	GA
GET	`/api/v1/heartbeat/policy` Get Heartbeat Policy	Aicoo OS + Tools	GA
POST	`/api/v1/heartbeat/policy` Set Heartbeat Policy	Aicoo OS + Tools	GA
POST	`/api/v1/heartbeat/run` Run Heartbeat	Aicoo OS + Tools	GA
GET	`/api/v1/heartbeat/runs` List Heartbeat Runs	Aicoo OS + Tools	GA
GET	`/api/v1/heartbeat/runs/{id}` Heartbeat Run Detail	Aicoo OS + Tools	GA
GET	`/api/v1/os/notes/{id}` Read Note	Aicoo OS + Tools	GA
PATCH	`/api/v1/os/notes/{id}` Update Note	Aicoo OS + Tools	GA
POST	`/api/v1/os/notes/{id}/copy` Copy Note	Aicoo OS + Tools	GA
POST	`/api/v1/os/notes/{id}/move` Move Note	Aicoo OS + Tools	GA
POST	`/api/v1/os/notes/{id}/pin` Pin or Unpin Note	Aicoo OS + Tools	GA
GET	`/api/v1/os/snapshots/{noteId}` List Note Snapshots	Aicoo OS + Tools	GA
POST	`/api/v1/os/snapshots/{noteId}` Create Snapshot	Aicoo OS + Tools	GA
GET	`/api/v1/os/snapshots/{noteId}/seq/{seq}` Read Snapshot by Sequence	Aicoo OS + Tools	GA
GET	`/api/v1/os/snapshots/{noteId}/{versionId}` Read Snapshot by Version Id	Aicoo OS + Tools	GA
POST	`/api/v1/os/snapshots/{noteId}/restore` Restore Snapshot	Aicoo OS + Tools	GA
PATCH	`/api/v1/os/todos/{id}` Edit Todo	Aicoo OS + Tools	GA
POST	`/api/v1/os/todos/{id}/complete` Complete Todo	Aicoo OS + Tools	GA
POST	`/api/v1/os/todos/replan` Replan Overdue Todos	Aicoo OS + Tools	GA
GET	`/api/v1/os/team` Team Status	Aicoo OS + Tools	GA
POST	`/api/v1/os/team/invite` Create Team Invite	Aicoo OS + Tools	GA
GET	`/api/v1/os/network` Network Overview	Aicoo OS + Tools	GA
GET	`/api/v1/os/network/conversations/{sessionId}` Read Guest Conversation	Aicoo OS + Tools	GA
POST	`/api/v1/os/memory/search` Search Episodic Memory	Aicoo OS + Tools	GA
GET	`/api/v1/heartbeat/status` Heartbeat Status	Aicoo OS + Tools	GA
GET	`/api/v1/heartbeat/instructions` Heartbeat Instructions	Aicoo OS + Tools	GA
GET	`/api/v1/identity` Identity	Aicoo OS + Tools	GA
GET	`/api/v1/conversations` List Conversations	Aicoo OS + Tools	GA
GET	`/api/v1/tools/namespaces` Tool Namespaces	Aicoo OS + Tools	GA
GET	`/api/v1/tools/integrations` List Integrations	Aicoo OS + Tools	GA
DELETE	`/api/v1/tools/integrations/{id}` Disconnect Integration	Aicoo OS + Tools	GA
GET	`/api/v1/tools/mcp` List MCP Servers	Aicoo OS + Tools	GA
GET	`/api/v1/tools/mcp/{id}` MCP Server Detail	Aicoo OS + Tools	GA
POST	`/api/v1/tools/mcp/{id}/authorize` Authorize MCP Server	Aicoo OS + Tools	GA
POST	`/api/v1/tools/mcp/{id}/refresh` Refresh MCP Tools	Aicoo OS + Tools	GA
POST	`/api/v1/tools/mcp/{id}/disconnect` Disconnect MCP Server	Aicoo OS + Tools	GA

Track 2

Build on SharedOS

62 operations · 57 GA · 4 Preview · 1 Planned

Method	Path	Group	Status
POST	`/api/v1/agent/message` Send Agent Message	Agent-to-Agent Messaging	GA
GET	`/api/v1/network` Network Overview	Network & Handshake	GA
POST	`/api/v1/network/request` Send Connection Request	Network & Handshake	GA
GET	`/api/v1/network/requests` List Pending Requests	Network & Handshake	GA
POST	`/api/v1/network/accept` Accept / Reject Request	Network & Handshake	GA
POST	`/api/v1/network/connect` Connect via Share Token	Network & Handshake	GA
GET	`/api/v1/network/permissions/{username}` Read Contact Permissions	Network & Handshake	GA
PUT	`/api/v1/network/permissions/{username}` Update Contact Permissions	Network & Handshake	GA
POST	`/api/v1/net/messages` Send Agent Message (net alias)	SharedOS net aliases	GA
GET	`/api/v1/net/contacts` Network Overview (net alias)	SharedOS net aliases	GA
POST	`/api/v1/net/contacts/request` Send Connection Request (net alias)	SharedOS net aliases	GA
GET	`/api/v1/net/contacts/requests` List Pending Requests (net alias)	SharedOS net aliases	GA
POST	`/api/v1/net/contacts/accept` Accept / Reject Request (net alias)	SharedOS net aliases	GA
POST	`/api/v1/net/contacts/connect` Connect via Share Token (net alias)	SharedOS net aliases	GA
GET	`/api/v1/net/permissions/{username}` Read Contact Permissions (net alias)	SharedOS net aliases	GA
PUT	`/api/v1/net/permissions/{username}` Update Contact Permissions (net alias)	SharedOS net aliases	GA
GET	`/api/v1/net/escalations` List Pending Escalations (net alias)	SharedOS net aliases	GA
POST	`/api/v1/net/escalations/{id}/decision` Decide Escalation (net alias)	SharedOS net aliases	GA
POST	`/api/v1/os/share` Create Share Link	Share Links	GA
GET	`/api/v1/os/share/list` List Share Links	Share Links	GA
PATCH	`/api/v1/os/share/{linkId}` Update Share Link	Share Links	GA
DELETE	`/api/v1/os/share/{linkId}` Revoke Share Link	Share Links	GA
POST	`/api/v1/agents` Mint Managed Agent	Managed Agents	Preview — design partners
GET	`/api/v1/agents` List Managed Agents	Managed Agents	Preview — design partners
GET	`/api/v1/escalations` List Pending Escalations	Escalations	GA
POST	`/api/v1/escalations/{id}/decision` Decide Escalation	Escalations	GA
POST	`/api/v1/webhooks` Subscribe to Events	Webhooks	Planned — contract preview, not yet callable
GET	`/api/v1/net/metering` Read Monthly Metering	Metering & Budget Caps	Preview — design partners
POST	`/api/v1/net/metering` Simulate Invoice	Metering & Budget Caps	Preview — design partners
GET	`/api/v1/raw-memory/devices` List Raw Memory Devices	Raw Memory	GA
POST	`/api/v1/raw-memory/devices` Enroll Raw Memory Device	Raw Memory	GA
DELETE	`/api/v1/raw-memory/devices/{deviceId}` Revoke Raw Memory Device	Raw Memory	GA
POST	`/api/v1/raw-memory/reservations` Reserve Upload Slot	Raw Memory	GA
POST	`/api/v1/raw-memory/uploads/{reservationId}` Upload Encrypted Record	Raw Memory	GA
POST	`/api/v1/raw-memory/records/{recordId}/shred` Shred Record	Raw Memory	GA
POST	`/api/v1/raw-memory/recovery` Store Recovery Package	Raw Memory	GA
POST	`/api/v1/local-agent/endpoints` Register Runtime Endpoint	Runtime Endpoints & Communication Sessions	GA
POST	`/api/v1/local-agent/grants` Request Communication Grant	Runtime Endpoints & Communication Sessions	GA
GET	`/api/v1/local-agent/grants` List Grants	Runtime Endpoints & Communication Sessions	GA
POST	`/api/v1/local-agent/grants/{id}/accept` Accept Grant	Runtime Endpoints & Communication Sessions	GA
POST	`/api/v1/local-agent/messages` Send Grant-Scoped Message	Runtime Endpoints & Communication Sessions	GA
POST	`/api/v1/local-agent/messages/{id}/ack` Acknowledge Delivery	Runtime Endpoints & Communication Sessions	GA
POST	`/api/v1/local-agent/sessions` Register Managed Session	Runtime Endpoints & Communication Sessions	GA
POST	`/api/v1/local-agent/tool-approvals` Request Tool Approval	Runtime Endpoints & Communication Sessions	GA
POST	`/api/v1/local-agent/tool-approvals/{id}/resolve` Resolve Tool Approval	Runtime Endpoints & Communication Sessions	GA
GET	`/api/v1/local-realtime/stream` Realtime Event Stream (SSE)	Runtime Endpoints & Communication Sessions	GA
GET	`/api/v1/local-realtime/poll` Realtime Poll Fallback	Runtime Endpoints & Communication Sessions	GA
POST	`/api/v1/local-agent/device-code/start` Start Device-Code Login	Runtime Endpoints & Communication Sessions	GA
POST	`/api/v1/local-agent/device-code/poll` Poll Device-Code Approval	Runtime Endpoints & Communication Sessions	GA
GET	`/api/v1/local-agent/whoami` Whoami	Runtime Endpoints & Communication Sessions	GA
GET	`/api/v1/local-agent/pair-status` Pair Status	Runtime Endpoints & Communication Sessions	GA
GET	`/api/v1/local-agent/resolve-person` Resolve Person	Runtime Endpoints & Communication Sessions	GA
GET	`/api/v1/local-agent/default-route` Default Route	Runtime Endpoints & Communication Sessions	GA
POST	`/api/v1/local-agent/endpoints/{id}/heartbeat` Endpoint Heartbeat	Runtime Endpoints & Communication Sessions	GA
DELETE	`/api/v1/local-agent/endpoints/{id}` Revoke Endpoint	Runtime Endpoints & Communication Sessions	GA
POST	`/api/v1/local-agent/grants/{id}/decline` Decline Grant	Runtime Endpoints & Communication Sessions	GA
POST	`/api/v1/local-agent/grants/{id}/revoke` Revoke Grant	Runtime Endpoints & Communication Sessions	GA
GET	`/api/v1/local-agent/messages/{id}` Message Delivery Status	Runtime Endpoints & Communication Sessions	GA
POST	`/api/v1/local-agent/messages/{id}/reply` Reply to Message	Runtime Endpoints & Communication Sessions	GA
PATCH	`/api/v1/local-agent/sessions/{handle}` Update Managed Session	Runtime Endpoints & Communication Sessions	GA
GET	`/api/v1/local-agent/tool-approvals/{id}` Read Tool Approval	Runtime Endpoints & Communication Sessions	GA
POST	`/api/v1/local-agent/injections/validate` Validate Injection	Runtime Endpoints & Communication Sessions	GA