Skip to main content
Agents are created with a schedule and an instruction. The agent will run the instruction at the scheduled time. The agent that runs the task is Zo (another instance of yourself, with all the same tools, running on the same computer). Keep this in mind when writing the instruction: it should be specific, detailed, reference specific files, directories, and tools, and include all the context, examples, and nudges needed to give it the best chance of successfully completing the task.

Parameters

agent_id
string
required
The unique identifier of the agent to modify
instruction
string
Optional. The new instruction text to replace the existing one. Omit to keep unchanged.
rrule
string
Optional. New RFC 5545 RRULE string (bare RRULE without DTSTART or TZID — system adds these automatically). Omit to keep unchanged.
delivery_method
string
Optional. ‘email’, ‘sms’, ‘telegram’, or ‘none’ to clear. Omit to keep unchanged.
model
string
Optional model ID. Call tool_docs(‘create_agent’) or tool_docs(‘edit_agent’) to see available model IDs. User-specific BYOK model IDs in the format ‘byok:your_config_id’ are also accepted.
active
boolean
Optional. True to resume a paused task, False to pause it. Omit to keep unchanged.