Skip to content

WorkflowSaveRequest

← All HTTP schemas

Request to save a workflow definition.

Shape: object

Property Required Type Description Rules
displayName no string Name shown in the UI.
description no string Short description of what the workflow does.
kind no WorkflowKind Built-in pattern to use.
agentNames no array Names of agents to add to the graph.
nodes no array Ordered agent/function node list for a Sequential workflow that mixes function nodes in with agents. Mutually exclusive with IReadOnlyList<string>? WorkflowSaveRequest.AgentNames; leave both empty or set only one.
managerAgentName no string Name of the manager agent. Only for WorkflowKind.Magentic.
maxIterations no integer (int32) Maximum number of turns. pattern `^-?(?:0\
handoffInstructions no string Handoff instructions. Only for WorkflowKind.Handoff.
requirePlanApproval no boolean Whether the manager agent’s plan must be approved by a human. Only for WorkflowKind.Magentic.