Skip to main content

Orchestration

This page is auto-generated from the formations OpenAPI spec. Do not edit manually — run pnpm generate-formations-resource-docs to regenerate.

Creates a DAG orchestration that wires agents, tools, and knowledge lookups into a repeatable pipeline within the formation's project. Node resource references (agent_id, tool_id, memory_id, orchestration_id) accept { "ref": "LogicalId" } expressions to point at other resources declared in the same template — the basis for deploying an agent "squad" (a team of agents plus the flow that coordinates them) as a single stack.

Syntax​

type: orchestration
properties:
  name: String
  description: String
  nodes: Object[]
  edges: Object[]
  state_schema: Object
  input_schema: Object

Output​

The physical resource ID is the public ID of the created resource. Reference it from other resources with a ref expression:

      some_field:
        ref: MyOrchestration

Properties​

name

Human-readable name for the orchestration

Required: Yes Type: String

description

Optional description of what the orchestration does

Required: No Type: String Nullable: Yes

nodes

Ordered list of node definitions. A node's resource references (agent_id, tool_id, memory_id, orchestration_id) may use { "ref": "LogicalId" } to bind to other resources in the template.

Required: Yes Type: Array of Object

edges

Directed connections between nodes

Required: Yes Type: Array of Object

state_schema

Optional JSON Schema describing the run state

Required: No Type: Object Nullable: Yes

input_schema

Optional JSON Schema describing the run input

Required: No Type: Object Nullable: Yes