Workers API

The Workers API provides endpoints to list, inspect, and start workflows for AI workers.

Endpoints

List Workers

GET /api/workers

Returns all 8 AI workers with their current status.

Response:

{
  "workers": [
    {
      "id": "sarah-ae-west",
      "name": "Sarah AE West",
      "role": "Account Executive",
      "status": "running",
      "currentTask": "Preparing call brief for Acme Corp",
      "memoryEntries": 128,
      "activeWorkflows": [
        "client-onboarding-acme-001",
        "call-prep-acme-047"
      ]
    },
    {
      "id": "mike-bdr-east",
      "name": "Mike BDR East",
      "role": "Business Development",
      "status": "running",
      "currentTask": "Scoring call recording - Datadog",
      "memoryEntries": 96,
      "activeWorkflows": [
        "call-scoring-datadog-012"
      ]
    }
  ]
}

Get Worker

GET /api/workers/:id

Returns detailed information about a specific worker.

Parameters:

Parameter	Type	Description
`id`	string	Worker ID (e.g., `sarah-ae-west`)

Response:

{
  "id": "sarah-ae-west",
  "name": "Sarah AE West",
  "role": "Account Executive",
  "status": "running",
  "currentTask": "Preparing call brief for Acme Corp",
  "memoryEntries": 128,
  "activeWorkflows": [
    "client-onboarding-acme-001",
    "call-prep-acme-047"
  ],
  "memory": {
    "pinnedFacts": 12,
    "totalEntries": 128,
    "lastCompression": "2026-03-04T06:00:00Z"
  }
}

Start Workflow

POST /api/workers/:id/start

Start a new workflow for a worker.

Parameters:

Parameter	Type	Description
`id`	string	Worker ID

Request:

{
  "workflowType": "client-onboarding",
  "params": {
    "accountId": "acme-corp",
    "accountName": "Acme Corp",
    "tier": "enterprise"
  }
}

Response:

{
  "workflowId": "client-onboarding-acme-002",
  "status": "started",
  "worker": "sarah-ae-west"
}

Available workflow types:

Type	Description	Required Params
`client-onboarding`	5-step onboarding flow	`accountId`, `accountName`
`lead-qualification`	Lead scoring and routing	`leadId`, `company`, `contact`
`content-generation`	Content creation	`contentType`, `accountId`
`ticket-resolution`	Ticket analysis + SLA	`ticketId`, `subject`, `priority`

Worker Status Values

Status	Meaning
`running`	Actively executing a workflow
`waiting`	Paused at a human approval gate
`stopped`	No active workflows

Data Source

:::info When Temporal Cloud is connected, worker data comes from live workflow queries. When running in demo mode, the API returns simulated worker data. :::

Workers API

Workers API

Endpoints

List Workers

Get Worker

Start Workflow

Worker Status Values

Data Source

On this page