Skip to main content

​
Backend API Admin Routes

These routes are exposed from platform-api on the backend/admin API surface. Key properties:
  • authenticated with backend API credentials
  • deployment-admin scope
  • actor scope is explicit on actor-rooted list/search/create routes
  • no stream endpoints

​
Control plane

​
Agents

MethodPathPurpose
GET/ai/agentsList deployment AI agents.
POST/ai/agentsCreate an AI agent.
GET/ai/agents/{agent_id}Get an AI agent.
PATCH/ai/agents/{agent_id}Update an AI agent.
DELETE/ai/agents/{agent_id}Delete an AI agent.
GET/ai/agents/{agent_id}/detailsGet extended agent details.
POST/ai/agents/{agent_id}/skillsImport an agent skill bundle.
DELETE/ai/agents/{agent_id}/skillsDelete an agent skill path.
GET/ai/agents/{agent_id}/skills/treeList agent skill tree.
GET/ai/agents/{agent_id}/skills/fileRead an agent skill file.
GET/ai/agents/{agent_id}/sub-agentsList attached sub-agents.
POST/ai/agents/{agent_id}/sub-agents/{sub_agent_id}Attach a sub-agent.
DELETE/ai/agents/{agent_id}/sub-agents/{sub_agent_id}Detach a sub-agent.
GET/ai/agents/{agent_id}/toolsList agent tools.
POST/ai/agents/{agent_id}/tools/{tool_id}Attach a tool to an agent.
DELETE/ai/agents/{agent_id}/tools/{tool_id}Detach a tool from an agent.
GET/ai/agents/{agent_id}/knowledge-basesList agent knowledge bases.
POST/ai/agents/{agent_id}/knowledge-bases/{kb_id}Attach a knowledge base.
DELETE/ai/agents/{agent_id}/knowledge-bases/{kb_id}Detach a knowledge base.

​
Tools

MethodPathPurpose
GET/ai/toolsList deployment AI tools.
POST/ai/toolsCreate an AI tool.
GET/ai/tools/{tool_id}Get an AI tool.
PATCH/ai/tools/{tool_id}Update an AI tool.
DELETE/ai/tools/{tool_id}Delete an AI tool.

​
Knowledge bases

MethodPathPurpose
GET/ai/knowledge-basesList deployment knowledge bases.
POST/ai/knowledge-basesCreate a knowledge base.
GET/ai/knowledge-bases/{kb_id}Get a knowledge base.
PATCH/ai/knowledge-bases/{kb_id}Update a knowledge base.
DELETE/ai/knowledge-bases/{kb_id}Delete a knowledge base.
GET/ai/knowledge-bases/{kb_id}/documentsList knowledge-base documents.
POST/ai/knowledge-bases/{kb_id}/documentsUpload a document.
DELETE/ai/knowledge-bases/{kb_id}/documents/{document_id}Delete a document.

​
MCP servers and settings

MethodPathPurpose
GET/ai/mcp-serversList deployment MCP servers.
POST/ai/mcp-serversCreate an MCP server.
POST/ai/mcp-servers/discoverDiscover MCP auth requirements.
GET/ai/mcp-servers/{mcp_server_id}Get an MCP server.
PATCH/ai/mcp-servers/{mcp_server_id}Update an MCP server.
DELETE/ai/mcp-servers/{mcp_server_id}Delete an MCP server.
GET/ai/settingsRead deployment AI settings.
PUT/ai/settingsUpdate deployment AI settings.

​
Actor-project runtime administration

​
Actor projects

MethodPathPurpose
GET/ai/actor-projectsList actor projects for actor_id.
GET/ai/actor-projects/searchCursor-search actor projects for actor_id.
POST/ai/actor-projectsCreate an actor project for actor_id.
GET/ai/actor-projects/{project_id}Get an actor project.
POST/ai/actor-projects/{project_id}/updateUpdate a project.
POST/ai/actor-projects/{project_id}/archiveArchive a project.
POST/ai/actor-projects/{project_id}/unarchiveUnarchive a project.
GET/ai/actor-projects/{project_id}/boardGet the project task board.
GET/ai/actor-projects/{project_id}/board/itemsList project board items.
POST/ai/actor-projects/{project_id}/board/itemsCreate a project board item.
GET/ai/actor-projects/{project_id}/board/items/{item_id}Get a board item.
GET/ai/actor-projects/{project_id}/board/items/{item_id}/eventsList board-item events.
GET/ai/actor-projects/{project_id}/board/items/{item_id}/assignmentsList board-item assignments.
GET/ai/actor-projects/{project_id}/board/items/{item_id}/filesystemList board-item workspace files.
GET/ai/actor-projects/{project_id}/board/items/{item_id}/filesystem/fileRead a board-item workspace file.
POST/ai/actor-projects/{project_id}/board/items/{item_id}/updateUpdate a board item.
POST/ai/actor-projects/{project_id}/board/items/{item_id}/archiveArchive a board item.
POST/ai/actor-projects/{project_id}/board/items/{item_id}/unarchiveUnarchive a board item.
POST/ai/actor-projects/{project_id}/board/items/{item_id}/journalAppend a board-item journal entry.
GET/ai/actor-projects/{project_id}/threadsList project threads.
POST/ai/actor-projects/{project_id}/threadsCreate a project thread.

​
Actor project threads

MethodPathPurpose
GET/ai/actor-project-threads/searchCursor-search actor project threads for actor_id.
GET/ai/actor-project-threads/{thread_id}Get a thread.
POST/ai/actor-project-threads/{thread_id}/updateUpdate a thread.
POST/ai/actor-project-threads/{thread_id}/archiveArchive a thread.
POST/ai/actor-project-threads/{thread_id}/unarchiveUnarchive a thread.
GET/ai/actor-project-threads/{thread_id}/eventsList thread events.
GET/ai/actor-project-threads/{thread_id}/assignmentsList thread assignments.
GET/ai/actor-project-threads/{thread_id}/task-graphsGet the latest thread task graph.
GET/ai/actor-project-threads/{thread_id}/messagesList thread messages.
GET/ai/actor-project-threads/{thread_id}/filesystemList thread filesystem entries.
GET/ai/actor-project-threads/{thread_id}/filesystem/fileDownload a thread filesystem file.
POST/ai/actor-project-threads/{thread_id}/runEnqueue execution for the thread.

​
Actor MCP servers

MethodPathPurpose
GET/ai/actor-mcp-serversList actor MCP connections for actor_id.
POST/ai/actor-mcp-servers/{mcp_server_id}/connectStart actor MCP OAuth/connect flow.
POST/ai/actor-mcp-servers/{mcp_server_id}/disconnectDisconnect actor MCP server.

​
Notes

  • These backend routes intentionally do not expose a stream endpoint.
  • For end-user session-scoped runtime APIs, use the frontend API surface instead.
  • Actor scope is explicit only on actor-rooted list/search/create and actor-MCP routes.