Skip to content

API Reference

All workspace routes require a resolved session except the Telegram webhook endpoint.

Session and workspaces

  • GET /api/auth/session returns the current user, workspace, role, and permissions.
  • GET /api/workspaces lists workspaces the current user can access.
  • GET /api/workspaces/:workspaceId/overview returns high-level counts for agents, runs, skills, messages, tasks, schedules, and approvals.

Agents and runs

  • GET /api/workspaces/:workspaceId/agents lists agents.
  • POST /api/workspaces/:workspaceId/agents creates an agent and its first version.
  • GET /api/workspaces/:workspaceId/agents/:agentId returns an agent and active version details.
  • PATCH /api/workspaces/:workspaceId/agents/:agentId updates the active model for an agent by creating a new version.
  • POST /api/workspaces/:workspaceId/agents/:agentId/runs enqueues a manual run.
  • GET /api/workspaces/:workspaceId/runs lists runs.
  • GET /api/workspaces/:workspaceId/runs/:runId returns a run and its steps.
  • POST /api/workspaces/:workspaceId/runs/:runId/cancel cancels a run.
  • POST /api/workspaces/:workspaceId/runs/:runId/replay requeues a run from the existing input.
  • GET /api/workspaces/:workspaceId/runs/:runId/trace fetches the stored run trace from R2.
  • GET /api/workspaces/:workspaceId/queue/dead-letter lists dead-letter queue jobs.

Tasks and schedules

  • GET /api/workspaces/:workspaceId/tasks lists tasks.
  • POST /api/workspaces/:workspaceId/tasks creates a task.
  • GET /api/workspaces/:workspaceId/tasks/:taskId returns a task.
  • PATCH /api/workspaces/:workspaceId/tasks/:taskId updates a task.
  • POST /api/workspaces/:workspaceId/tasks/:taskId/cancel cancels a task.
  • POST /api/workspaces/:workspaceId/tasks/:taskId/pause pauses a task.
  • POST /api/workspaces/:workspaceId/tasks/:taskId/resume resumes a task.
  • POST /api/workspaces/:workspaceId/tasks/:taskId/snooze moves a task to a later due date.
  • POST /api/workspaces/:workspaceId/tasks/:taskId/retry retries a task.
  • DELETE /api/workspaces/:workspaceId/tasks/:taskId deletes a task.
  • GET /api/workspaces/:workspaceId/schedules lists schedules.
  • POST /api/workspaces/:workspaceId/schedules creates a schedule.
  • GET /api/workspaces/:workspaceId/schedules/:scheduleId returns a schedule.
  • PATCH /api/workspaces/:workspaceId/schedules/:scheduleId updates a schedule.
  • POST /api/workspaces/:workspaceId/schedules/:scheduleId/pause pauses a schedule.
  • POST /api/workspaces/:workspaceId/schedules/:scheduleId/resume resumes a schedule.
  • DELETE /api/workspaces/:workspaceId/schedules/:scheduleId deletes a schedule.

Skills and tools

  • GET /api/workspaces/:workspaceId/skills lists skills.
  • POST /api/workspaces/:workspaceId/skills creates a skill and its active version.
  • GET /api/workspaces/:workspaceId/tools lists tools.
  • POST /api/workspaces/:workspaceId/tools creates a tool.
  • GET /api/workspaces/:workspaceId/tools/:toolId returns a tool.
  • PATCH /api/workspaces/:workspaceId/tools/:toolId updates a tool.
  • DELETE /api/workspaces/:workspaceId/tools/:toolId deletes a tool.
  • GET /api/workspaces/:workspaceId/agents/:agentId/tools lists agent-tool bindings.
  • POST /api/workspaces/:workspaceId/agents/:agentId/tools binds a tool to an agent.
  • DELETE /api/workspaces/:workspaceId/agents/:agentId/tools/:toolId unbinds a tool.

Approvals, memory, messaging, and usage

  • GET /api/workspaces/:workspaceId/approvals lists approvals.
  • POST /api/workspaces/:workspaceId/approvals/:approvalId/approve approves an item.
  • POST /api/workspaces/:workspaceId/approvals/:approvalId/deny denies an item.
  • GET /api/workspaces/:workspaceId/memory lists memory records.
  • GET /api/workspaces/:workspaceId/messages lists messaging activity.
  • GET /api/workspaces/:workspaceId/usage returns grouped usage and cost totals.

Integrations

  • POST /api/integrations/telegram/webhook receives Telegram webhook events.

Permission model

The API checks workspace permissions before mutating data.

  • agent.read and agent.write cover agent inspection and updates.
  • agent.run covers run creation and cancellation.
  • run.inspect covers run history, traces, usage, and dead-letter inspection.
  • task.manage and schedule.manage cover automation CRUD.
  • skill.manage and tool.manage cover registry changes.
  • approval.write covers approval decisions.
  • memory.manage, integration.manage, and settings.manage gate the corresponding operational surfaces.

Cloudflare-native agent orchestration platform