Workflow

This is a type used in Stencila Schema for reusable AI workflow definitions.

It exists to represent a workflow as a document-like artifact with metadata, human-readable guidance, and a machine-executable pipeline defined in Graphviz DOT. Workflows are discovered from .stencila/workflows/<name>/WORKFLOW.md and can reference agents by name, allowing shared workflow structures to be combined with workspace or user-level agent definitions.

Key properties include name, content, pipeline, goal, goalHint, and overrides.

Properties

The Workflow type has these properties:

Name	Description	Type	Inherited from
`name`	The name of the workflow.	`String`	-
`whenToUse`	Positive selection signals describing when this workflow should be used.	`String`*	-
`whenNotToUse`	Negative selection signals describing when this workflow should not be used.	`String`*	-
`frontmatter`	Frontmatter containing workflow metadata.	`String`	-
`content`	The content of the workflow (Markdown body containing the DOT pipeline and documentation).	`Block`*	-
`pipeline`	The raw DOT source defining the pipeline digraph.	`String`	-
`goal`	A fixed, predetermined high-level goal for the pipeline.	`String`	-
`goalHint`	Hint text displayed in user interfaces to guide the user to provide a specific goal.	`String`	-
`overrides`	CSS-like rules for per-node agent overrides across the pipeline.	`String`	-
`defaultMaxRetry`	Global retry ceiling for nodes that omit max_retries.	`Integer`	-
`retryTarget`	Node ID to jump to if exit is reached with unsatisfied goal gates.	`String`	-
`fallbackRetryTarget`	Secondary jump target if retryTarget is missing or invalid.	`String`	-
`defaultFidelity`	Default context fidelity mode for LLM sessions.	`String`	-
`workType`	The type of `CreativeWork` (e.g. article, book, software application).	`CreativeWorkType`	`CreativeWork`
`doi`	The work's Digital Object Identifier (https://doi.org/).	`String`	`CreativeWork`
`about`	The subject matter of the content.	`ThingVariant`*	`CreativeWork`
`abstract`	A short description that summarizes a `CreativeWork`.	`Block`*	`CreativeWork`
`authors`	The authors of the `CreativeWork`.	`Author`*	`CreativeWork`
`provenance`	A summary of the provenance of the content within the work.	`ProvenanceCount`*	`CreativeWork`
`contributors`	A secondary contributor to the `CreativeWork`.	`Author`*	`CreativeWork`
`editors`	People who edited the `CreativeWork`.	`Person`*	`CreativeWork`
`maintainers`	The maintainers of the `CreativeWork`.	(`Person` \| `Organization`)*	`CreativeWork`
`comments`	Comments about this creative work.	`Comment`*	`CreativeWork`
`dateCreated`	Date/time of creation.	`DateTime`	`CreativeWork`
`dateReceived`	Date/time that work was received.	`DateTime`	`CreativeWork`
`dateAccepted`	Date/time of acceptance.	`DateTime`	`CreativeWork`
`dateModified`	Date/time of most recent modification.	`DateTime`	`CreativeWork`
`datePublished`	Date of first publication.	`DateTime`	`CreativeWork`
`funders`	People or organizations that funded the `CreativeWork`.	(`Person` \| `Organization`)*	`CreativeWork`
`fundedBy`	Grants that funded the `CreativeWork`; reverse of `fundedItems`.	(`Grant` \| `MonetaryGrant`)*	`CreativeWork`
`genre`	Genre of the creative work, broadcast channel or group.	`String`*	`CreativeWork`
`keywords`	Keywords or tags used to describe this content. Multiple entries in a keywords list are typically delimited by commas.	`String`*	`CreativeWork`
`isPartOf`	An item or other CreativeWork that this CreativeWork is a part of.	`CreativeWorkVariant`	`CreativeWork`
`licenses`	License documents that applies to this content, typically indicated by URL, but may be a `CreativeWork` itself.	(`CreativeWorkVariant` \| `String`)*	`CreativeWork`
`parts`	Elements of the collection which can be a variety of different elements, such as Articles, Datatables, Tables and more.	`CreativeWorkVariant`*	`CreativeWork`
`publisher`	A publisher of the CreativeWork.	`Person` \| `Organization`	`CreativeWork`
`bibliography`	A bibliography of references which may be cited in the work.	`Bibliography`	`CreativeWork`
`references`	References to other creative works, such as another publication, web page, scholarly article, etc.	`Reference`*	`CreativeWork`
`text`	The textual content of this creative work.	`Text`	`CreativeWork`
`title`	The title of the creative work.	`Inline`*	`CreativeWork`
`repository`	URL of the repository where the un-compiled, human readable source of the work is located.	`String`	`CreativeWork`
`path`	The file system path of the source of the work.	`String`	`CreativeWork`
`commit`	The commit hash (or similar) of the source of the work.	`String`	`CreativeWork`
`version`	The version of the creative work.	`String` \| `Number`	`CreativeWork`
`alternateNames`	Alternate names (aliases) for the item.	`String`*	`Thing`
`description`	A description of the item.	`String`	`Thing`
`identifiers`	Any kind of identifier for any kind of Thing.	(`PropertyValue` \| `String`)*	`Thing`
`images`	Images of the item.	`ImageObject`*	`Thing`
`url`	The URL of the item.	`String`	`Thing`
`id`	The identifier for this item.	`String`	`Entity`