Skip to main content

Agents

Create, configure, start, stop, and monitor autonomous AI agents. Each agent has its own role prompt, backlog, Discord channel, and activity log.

GET/api/agents

List all agents with their current status and backlog summary.

Response

{
  "agents": [
    {
      "id": "marketing-lead",
      "name": "Marketing Lead",
      "status": "active",
      "channel": "marketing",
      "backlog_summary": {
        "queued": 3,
        "in_progress": 1,
        "complete": 12
      }
    }
  ]
}
GET/api/agents/{agent_id}

Get full details for a single agent, including its role prompt and complete backlog.

Response

{
  "id": "marketing-lead",
  "name": "Marketing Lead",
  "status": "active",
  "channel": "marketing",
  "role_prompt": "You are a marketing agent...",
  "throttle_seconds": 0,
  "backlog": [ ... ],
  "created_at": "2026-03-28T10:00:00Z"
}
POST/api/agentsAuth required

Create a new agent. Requires authentication. Subject to your plan's agent limit.

Request Body

FieldTypeRequiredNote
idstringYesUnique slug, e.g. 'support-bot'
namestringYesDisplay name
role_promptstringYesAgent's system prompt / instructions
channelstringYesDiscord channel name
workspacestringNoOptional workspace grouping

Response

{
  "id": "support-bot",
  "name": "Support Bot",
  "status": "idle",
  "channel": "support",
  "created_at": "2026-03-28T10:00:00Z"
}
PATCH/api/agents/{agent_id}

Update agent configuration. All fields are optional — only include what you want to change.

Request Body

FieldTypeRequiredNote
namestringNo
role_promptstringNo
channelstringNo
statusstringNo"active" | "idle" | "vacation" | "error"
throttle_secondsnumberNoDelay between task executions

Response

{
  "id": "support-bot",
  "name": "Support Bot",
  "status": "active",
  "throttle_seconds": 30
}
DELETE/api/agents/{agent_id}

Permanently delete an agent and all its associated files (config, prompt, backlog).

Response

{ "deleted": "support-bot" }

Agent Controls

POST/api/agents/{agent_id}/start

Start the agent worker process. The agent will begin pulling and executing tasks from its backlog.

Response

{ "status": "started", "agent_id": "marketing-lead" }
POST/api/agents/{agent_id}/stop

Stop the agent worker. Sets status to idle. The agent finishes its current task before stopping.

Response

{ "status": "stopped", "agent_id": "marketing-lead" }
POST/api/agents/{agent_id}/vacation

Toggle vacation mode. When on vacation, the agent won't pick up new tasks but remains configured.

Response

{ "status": "vacation", "agent_id": "marketing-lead" }
GET/api/agents/{agent_id}/activity

Get the agent's recent activity log. Defaults to the last 30 entries.

Response

{
  "entries": [
    {
      "timestamp": "2026-03-28T14:30:00Z",
      "action": "task_completed",
      "details": "Wrote 3 LinkedIn posts about AI automation"
    }
  ]
}

Onboarding Templates

Use the onboarding API to quickly create agents from pre-built templates:

GET /api/onboarding/templates

# Returns available templates:
# marketing, support, engineering, operations, sales

POST /api/onboarding/setup
{
  "company_name": "Acme Corp",
  "role_template": "marketing"
}
# Creates agent + sample task automatically

See the Quick Start guide for a full walkthrough.