CAIN-42 CAIN Studio

API reference · schema

PlanCreateRequest

21 fields · used by 1 operations

Last reviewed 2026-10-02

Fields

FieldTypeMeaning
goal requiredstring
intent requiredstring
principalstring or null
agent_idstring or null
modestringdefault "BALANCED"
available_skillsarray of object or nulldefault []
relevant_memoriesarray of object or nulldefault []
available_toolsarray of string or nulldefault []
available_resourcesarray of string or nulldefault []
policy_contextobject or nulldefault {}
governance_contextobject or nulldefault {}
budgetobject or nulldefault {}
risk_contextobject or nulldefault {}
constraintsarray of object or nulldefault []
deadlinesobject or nulldefault {}
approval_requirementsarray of string or nulldefault []
trajectory_contextobject or nulldefault {}
previous_failed_plansarray of string or nulldefault []
previous_successful_plansarray of string or nulldefault []
optimizationmap of string to boolean or nulldefault {}
ttl_secondsintegerdefault 3600

Smallest valid example

{
  "goal": "goal",
  "intent": "intent",
  "mode": "BALANCED",
  "available_skills": [],
  "relevant_memories": [],
  "available_tools": [],
  "available_resources": [],
  "policy_context": {},
  "governance_context": {},
  "budget": {},
  "risk_context": {},
  "constraints": [],
  "deadlines": {},
  "approval_requirements": [],
  "trajectory_context": {},
  "previous_failed_plans": [],
  "previous_successful_plans": [],
  "optimization": {},
  "ttl_seconds": 3600
}

Used by 1 operation

POST/fabric/plansCreate Plan

JSON Schema

Show the raw definition
{
  "properties": {
    "goal": {
      "type": "string",
      "title": "Goal"
    },
    "intent": {
      "type": "string",
      "title": "Intent"
    },
    "principal": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Principal"
    },
    "agent_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Agent Id"
    },
    "mode": {
      "type": "string",
      "title": "Mode",
      "default": "BALANCED"
    },
    "available_skills": {
      "anyOf": [
        {
          "items": {
            "additionalProperties": true,
            "type": "object"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Available Skills",
      "default": []
    },
    "relevant_memories": {
      "anyOf": [
        {
          "items": {
            "additionalProperties": true,
            "type": "object"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Relevant Memories",
      "default": []
    },
    "available_tools": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Available Tools",
      "default": []
    },
    "available_resources": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Available Resources",
      "default": []
    },
    "policy_context": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Policy Context",
      "default": {}
    },
    "governance_context": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Governance Context",
      "default": {}
    },
    "budget": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Budget",
      "default": {}
    },
    "risk_context": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Risk Context",
      "default": {}
    },
    "constraints": {
      "anyOf": [
        {
          "items": {
            "additionalProperties": true,
            "type": "object"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Constraints",
      "default": []
    },
    "deadlines": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Deadlines",
      "default": {}
    },
    "approval_requirements": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Approval Requirements",
      "default": []
    },
    "trajectory_context": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Trajectory Context",
      "default": {}
    },
    "previous_failed_plans": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Previous Failed Plans",
      "default": []
    },
    "previous_successful_plans": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Previous Successful Plans",
      "default": []
    },
    "optimization": {
      "anyOf": [
        {
          "additionalProperties": {
            "type": "boolean"
          },
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Optimization",
      "default": {}
    },
    "ttl_seconds": {
      "type": "integer",
      "title": "Ttl Seconds",
      "default": 3600
    }
  },
  "type": "object",
  "required": [
    "goal",
    "intent"
  ],
  "title": "PlanCreateRequest"
}

Try CAIN-42 on your own agents

Create a free account and every new account starts with a 7-day trial of the full platform. Or try the sandbox first, with no account at all.

Create a free account →  ·  Try the sandbox  ·  See the whole ecosystem