Tasks

A task is a reusable instruction template attached to a teammate. Define the work once, then trigger it manually, on a schedule, via webhook, or by email.

Create a Task

Fields

FieldTypeDescription
teammate_idint (required)The teammate that runs this task
instructionsstring (required)What the teammate should do
namestringDisplay name for the task
toolsstring[]Override teammate tools for this task
expected_outputstringDescription of expected output format
goalsstringTask-specific goals
user_idstringEnd-user ID for multi-tenancy

Run a Task

Execute a saved task on demand:

Run Options

FieldTypeDefaultDescription
streambooltrueEnable real-time event streaming
user_idstringEnd-user ID for multi-tenancy
metadatadictArbitrary key-value data
memorybooltrueInclude saved per-user memories
historybooltrueInclude previous run context
human_in_the_loopboolfalseEnable interactive features — see Human-in-the-Loop
permission_modestring"autonomous"See Permissions. Requires human_in_the_loop for non-autonomous modes

Note: permission_mode values other than "autonomous" require human_in_the_loop=true.

For automated execution, attach a trigger instead — see below.

Run Tasks with Triggers

Tasks become automated when you attach a trigger:

TriggerHow it works
SchedulingCron expressions or fixed intervals
WebhookExternal systems POST to a URL to trigger the task
Email InboxInbound emails trigger a run

Quick Example: Schedule a Task

Python

Quick Example: Webhook Trigger

Python

Quick Example: Email Trigger

Python

List Tasks

Update a Task

Delete a Task

What's Next

  • Scheduling — automate tasks with cron and intervals
  • Webhook Triggers — trigger tasks from external systems
  • Runs — understand run execution and streaming