Appearance
API Reference
All workspace routes require a resolved session except the Telegram webhook endpoint.
Session and workspaces
GET /api/auth/sessionreturns the current user, workspace, role, and permissions.GET /api/workspaceslists workspaces the current user can access.GET /api/workspaces/:workspaceId/overviewreturns high-level counts for agents, runs, skills, messages, tasks, schedules, and approvals.
Agents and runs
GET /api/workspaces/:workspaceId/agentslists agents.POST /api/workspaces/:workspaceId/agentscreates an agent and its first version.GET /api/workspaces/:workspaceId/agents/:agentIdreturns an agent and active version details.PATCH /api/workspaces/:workspaceId/agents/:agentIdupdates the active model for an agent by creating a new version.POST /api/workspaces/:workspaceId/agents/:agentId/runsenqueues a manual run.GET /api/workspaces/:workspaceId/runslists runs.GET /api/workspaces/:workspaceId/runs/:runIdreturns a run and its steps.POST /api/workspaces/:workspaceId/runs/:runId/cancelcancels a run.POST /api/workspaces/:workspaceId/runs/:runId/replayrequeues a run from the existing input.GET /api/workspaces/:workspaceId/runs/:runId/tracefetches the stored run trace from R2.GET /api/workspaces/:workspaceId/queue/dead-letterlists dead-letter queue jobs.
Tasks and schedules
GET /api/workspaces/:workspaceId/taskslists tasks.POST /api/workspaces/:workspaceId/taskscreates a task.GET /api/workspaces/:workspaceId/tasks/:taskIdreturns a task.PATCH /api/workspaces/:workspaceId/tasks/:taskIdupdates a task.POST /api/workspaces/:workspaceId/tasks/:taskId/cancelcancels a task.POST /api/workspaces/:workspaceId/tasks/:taskId/pausepauses a task.POST /api/workspaces/:workspaceId/tasks/:taskId/resumeresumes a task.POST /api/workspaces/:workspaceId/tasks/:taskId/snoozemoves a task to a later due date.POST /api/workspaces/:workspaceId/tasks/:taskId/retryretries a task.DELETE /api/workspaces/:workspaceId/tasks/:taskIddeletes a task.GET /api/workspaces/:workspaceId/scheduleslists schedules.POST /api/workspaces/:workspaceId/schedulescreates a schedule.GET /api/workspaces/:workspaceId/schedules/:scheduleIdreturns a schedule.PATCH /api/workspaces/:workspaceId/schedules/:scheduleIdupdates a schedule.POST /api/workspaces/:workspaceId/schedules/:scheduleId/pausepauses a schedule.POST /api/workspaces/:workspaceId/schedules/:scheduleId/resumeresumes a schedule.DELETE /api/workspaces/:workspaceId/schedules/:scheduleIddeletes a schedule.
Skills and tools
GET /api/workspaces/:workspaceId/skillslists skills.POST /api/workspaces/:workspaceId/skillscreates a skill and its active version.GET /api/workspaces/:workspaceId/toolslists tools.POST /api/workspaces/:workspaceId/toolscreates a tool.GET /api/workspaces/:workspaceId/tools/:toolIdreturns a tool.PATCH /api/workspaces/:workspaceId/tools/:toolIdupdates a tool.DELETE /api/workspaces/:workspaceId/tools/:toolIddeletes a tool.GET /api/workspaces/:workspaceId/agents/:agentId/toolslists agent-tool bindings.POST /api/workspaces/:workspaceId/agents/:agentId/toolsbinds a tool to an agent.DELETE /api/workspaces/:workspaceId/agents/:agentId/tools/:toolIdunbinds a tool.
Approvals, memory, messaging, and usage
GET /api/workspaces/:workspaceId/approvalslists approvals.POST /api/workspaces/:workspaceId/approvals/:approvalId/approveapproves an item.POST /api/workspaces/:workspaceId/approvals/:approvalId/denydenies an item.GET /api/workspaces/:workspaceId/memorylists memory records.GET /api/workspaces/:workspaceId/messageslists messaging activity.GET /api/workspaces/:workspaceId/usagereturns grouped usage and cost totals.
Integrations
POST /api/integrations/telegram/webhookreceives Telegram webhook events.
Permission model
The API checks workspace permissions before mutating data.
agent.readandagent.writecover agent inspection and updates.agent.runcovers run creation and cancellation.run.inspectcovers run history, traces, usage, and dead-letter inspection.task.manageandschedule.managecover automation CRUD.skill.manageandtool.managecover registry changes.approval.writecovers approval decisions.memory.manage,integration.manage, andsettings.managegate the corresponding operational surfaces.