Skip to content

WorkflowDescriptor

← All HTTP schemas

Represents a summary view of a workflow listed in the catalog.

Shape: object

Property Required Type Description Rules
name yes string Gets the workflow’s unique name.
displayName no string Gets the display name shown in the UI.
description no string Gets the short description.
origin yes AgentDefinitionOrigin Gets the source of the definition.
kind no null oneOf WorkflowKind
agentNames no array of string Gets the agent names entering the graph. Can be empty for code-defined workflows.
nodes no array of WorkflowNodeReference Gets the mixed agent/function node list for a Sequential workflow that uses function nodes. Empty for every other definition.
version no integer (int32) Gets the definition version. Always 1 for code-defined workflows. pattern `^-?(?:0\
updatedAt no string (date-time) Gets the last modification time (UTC).