HTTP API
WorkflowDescriptor
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. | — |
parameters |
no | array of AgentParameter |
Gets the run parameters the workflow accepts. Empty for a workflow that takes none. For a workflow defined in code it is the schema its registration declared. | — |
responseMode |
no | WorkflowResponseMode |
Gets how the workflow treats more than one answer to the same pending human request. For a stored workflow this is the current version’s mode; a run that waits keeps the mode of the version it recorded. | — |
requestTimeout |
no | string |
Gets how long a human request of the workflow may wait for an answer; null when it waits without limit. For a stored workflow this is the current version’s value; a run that waits keeps the limit of the version it recorded. |
pattern ^-?(\d+\.)?\d{2}:\d{2}:\d{2}(\.\d{1,7})?$ |
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). | — |