BlueprintDefinition schema

The blueprint document type, validated against the published JSON schema.

Example

blueprint.json

{
  "blueprintId": "fixed-body",
  "name": "Fixed Count Body",
  "behaviour": {
    "loopConfig": {
      "terminationStrategy": "FIXED_COUNT",
      "maxIterations": 3
    },
    "transition": "AUTO"
  },
  "steps": [
    {
      "kind": "STEP",
      "stepId": "body",
      "name": "Loop Body",
      "behaviour": {
        "type": "AGENT",
        "agentRef": "loop-agent",
        "transition": "AUTO"
      }
    }
  ]
}

Properties

Property	Type	Required	Description
blueprintId	string	yes	Unique blueprint identifier (Unique to the workflow). Must match the filename stem.
name	string	yes	—
behaviour	BlueprintBehaviour	yes	—
steps	array of Executable	yes	—

Definitions

BlueprintBehaviour

Property	Type	Required	Description
transition	enum (AUTO, HUMAN_REVIEW, HUMAN_APPROVAL)	yes	—
loopConfig	LoopConfig | null	no	—

LoopConfig

Property	Type	Required	Description
terminationStrategy	enum (AGENT_SIGNAL, EVALUATOR, FIXED_COUNT, FOR_EACH)	yes	—
forEachContextKey	string	no	Required when terminationStrategy is FOR_EACH.
evaluatorAgentId	string	no	Required when terminationStrategy is EVALUATOR.
maxIterations	integer	yes	—
maxIterationsAction	enum (AWAIT_USER, FAIL)	no	—
expectedIterations	integer	no	Optional execution-estimation hint: expected-case iteration count (companion to the maxIterations ceiling). Must not exceed maxIterations. Advisory only; never affects runtime loop driving.

Executable

No properties.

BlueprintRef

Property	Type	Required	Description
kind	const BLUEPRINT_REF	yes	—
blueprintId	string	yes	—