Instance Plan

Manage instance plans. IMPORTANT: Instance plans are strict execution paths for YOU (the agent), composed of tool calls, processes, reviews, discussions, or user inputs to ensure task success. They are NOT general plans for the user. Use action=“create” to define a new execution path (use when the plan is different from the previous one). Use action=“list” to get current plans; use action=“update” to add new steps or reopen an existing plan (same objective, just new steps). Use action=“execute_step” to execute and record the result of each step individually. Always finish execution with a summary.

Input Schema

Parameter	Type	Description
action	string	Action to perform on instance plans. Enum: create, list, update, execute_step
instance_id	string	Instance UUID (required for create/list if not running in instance context)
plan_id	string	Plan UUID (required for update, and execute_step)
step_id	string	Step UUID (required for execute_step)
step_output	string	Output of the executed step (required for execute_step)
step_status	string	Status of the executed step (required for execute_step). Enum: pending, in_progress, completed, failed
title	string	Plan title
description	string	Plan description
plan_type	string	Type of plan. Must be one of: objective, task. Default: objective. Enum: objective, task
status	string	Plan status. For create, use “pending” or leave empty for default. Enum: pending, in_progress, completed, failed, cancelled, paused
steps	array	Array of plan steps with detailed properties.
site_id	string	Site UUID
user_id	string	User UUID
agent_id	string	Agent UUID
limit	number	Limit results
offset	number	Offset results

REST Endpoint

Actions map to sub-routes: create → /create, list → /get, update → /update.


POST /api/agents/tools/instance_plan/create
POST /api/agents/tools/instance_plan/get
POST /api/agents/tools/instance_plan/update


POST /api/agents/tools/instance_plan/create
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
 
{
  "site_id": "YOUR_SITE_ID",
  "instance_id": "INSTANCE_UUID",
  "title": "Lead qualification flow",
  "plan_type": "objective",
  "steps": [
    { "title": "Fetch lead data", "type": "tool_call" },
    { "title": "Qualify lead", "type": "process" }
  ]
}

Response:


{
  "success": true,
  "plan": { "id": "...", "title": "Lead qualification flow" }
}