surfaceFlowReferenceContextSource

This reference describes the full structure of surfaceFlowReferenceContextSource. Paths include nested objects, list items and conditional branches. A branch selected by kind, contract or mode only admits its own properties.

Structure and values

Field	Options / expected values	Description
key	string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u	Required. Stable semantic identifier used by references; changing it changes identity.
kind	"flow-reference"	Required. Selects the variant and the properties admitted in this branch.
source	closed object OR closed object	Required. Defines source for this object. Observe the type, variants and bounds in the Options column.
source.[kind=input].kind	"input"	Required. Selects the variant and the properties admitted in this branch.
source.[kind=input].key	string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u	Required. Stable semantic identifier used by references; changing it changes identity.
source.[kind=step-output].kind	"step-output"	Required. Selects the variant and the properties admitted in this branch.
source.[kind=step-output].stepKey	string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u	Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility.
source.[kind=step-output].outputKey	string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u	Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility.
required	true | false	Required. Whether a value is required by this declaration.
revision	"captured"	Required. Defines revision for this object. Observe the type, variants and bounds in the Options column.
priority	integer; ≥ 0; ≤ 1000	Required. Defines priority for this object. Observe the type, variants and bounds in the Options column.
maximumItems	integer; ≥ 1; ≤ 100	Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema.
maximumCharacters	integer; ≥ 1; ≤ 100000	Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema.

Reading the contract

A path ending in [] describes each list item; {key} describes each dictionary value. The ↻ marker refers to the same recursive expression. Closed objects reject additional properties. Semantic validation denotes an additional check: matching a type does not make a reference, permission or transition valid. References must resolve in the Model and the current user context.

An older variant cannot accept properties belonging to a newer variant. The compiler checks the version and consistency of the complete Model.

Structural example

This fragment passes the schema for this section. Its business references must be defined in the enclosing Model.

{
  "key": "feature",
  "kind": "flow-reference",
  "source": {
    "kind": "input",
    "key": "feature"
  },
  "required": true,
  "revision": "captured",
  "priority": 2,
  "maximumItems": 1,
  "maximumCharacters": 20000
}

Related references

Complete Model index · Build a Model

Applied examples : A proposal grounded in context

AI receives the client and required sources within the Model policy’s bounds.

Configuration

Contract object surfaceFlowReferenceContextSource. Properties and accepted values.

{
  "key": "feature",
  "kind": "flow-reference",
  "source": {
    "kind": "input",
    "key": "feature"
  },
  "required": true,
  "revision": "captured",
  "priority": 2,
  "maximumItems": 1,
  "maximumCharacters": 20000
}

Variation and connection

Fragment placed in contextPolicies[]. Properties and accepted values.

{
  "key": "quote-knowledge",
  "targetDefinitionPaths": [
    "workspace/quotes/surface/quote"
  ],
  "sources": [
    {
      "key": "pricing",
      "kind": "knowledge",
      "definitionPaths": [
        "workspace/knowledge/surface/pricing"
      ],
      "linkTypePaths": [],
      "queryKey": null,
      "required": true,
      "revision": "current",
      "priority": 1,
      "maximumItems": 3,
      "maximumCharacters": 12000
    }
  ],
  "maximumCharacters": 16000
}

UI layout example

The illustrative layout below places this configuration in the Clients/Quotes app. Insert each fragment at the stated location, with Field, Query and Action references matching the Model declarations.

1. Target object
2. Proposed change
3. Checks
4. Confirm

SurfaceClients / North StudioExample

surfaceFlowReferenceContextSourcesurfaceFlowReferenceContextSource

Clients

MODEL CONTEXTNorth StudioDeclarative configuration

key

feature

kind

flow-reference

source

Declared object

required

true

priority

2

Values above follow the configuration fragment; references resolve in the complete Model.