Skip to main content
Some legacy Agent API pages describe input content using Neuron Script assignment pattern-matching notation. This notation documents request shape and validation; it is not an HTTP query-filter language.

​
Common patterns

​
How to read a pattern

  1. The outer Required or Optional expression describes presence.
  2. The inner expression describes the expected value type.
  3. A condition inside the type expression describes validation.
  4. The P... variable names correspond to values consumed by the resource implementation; the JSON field names come from the operation’s documented request schema.

​
Canonical application contract

Application developers should use the generated OpenAPI schema for exact JSON field names, types, and required properties. Pattern notation remains documented so legacy examples and implementation-oriented reference material can be interpreted correctly. Do not translate these expressions into GET /v1/...?... filters. The Agent API publishes resources below /Agent and normally uses POST unless an individual resource states otherwise.