SyncWorkflowGraphBody

Request body for a Workflow operation.

Definition

TypeScript

interface SyncWorkflowGraphBody {
  nodes?:
    | Array<{
        type: "function" | "workflow" | "agent" | "swarm";
        name: string;
        config?: Record<string, unknown> | undefined;
      }>
    | undefined;
  edges?:
    | Array<{
        sourceNodeIndex: number | null;
        targetNodeIndex: number | null;
        handle?: string | null | undefined;
        priority?: number | undefined;
        label?: string | undefined;
      }>
    | undefined;
  entryNodeIndex?: number | undefined;
}

Fields

Field	Type	Notes
`nodes`	`Array<{ type: "function" \| "workflow" \| "agent" \| "swarm"; name: string; config?: Record<string, unknown> \| undefined; }> \| undefined`	`optional` — Full set of nodes; omit to leave existing nodes unchanged.
`edges`	`Array<{ sourceNodeIndex: number \| null; targetNodeIndex: number \| null; handle?: string \| null \| undefined; priority?: number \| undefined; label?: string \| undefined; }> \| undefined`	`optional` — Full set of edges referencing nodes by index; omit to leave unchanged.
`entryNodeIndex`	`number \| undefined`	`optional` — Index of the entry node within the `nodes` array.