Skip to main content

Schema

Use this page to reference artifact field types, descriptions, optionality, and nesting.

The Schema manifest: the envelope (apiVersion, kind, metadata; see Manifests) plus spec.

Fields​

SchemaSpec (spec)​

FieldTypeDefaultMeaning
fieldsdict[str, FieldSpec]requiredThe artifact's fields, by name.

FieldSpec (spec.fields)​

FieldTypeDefaultMeaning
typestrrequiredThe field's type: a scalar, object, list[…] or enum[a|b].
descriptionstr or nullnullWhat the field means, for a person and for the model.
optionalboolFalseWhether the field may be absent.
fieldsdict[str, FieldSpec] or nullnullFor object and list[object]: the nested fields, by name.

See also​

  • Flow for input and artifact references.
  • Agent for the artifact an agent writes.