Skip to main content

Workflow

Description

ValkyrAI Workflow object manages execution and state of automation workflows

Properties

NameTypeDescriptionNotes
nameStringshort description of this workflow[optional]
descriptionStringdetailed description of this workflow[optional]
roleRoleEnumthe role with permissions to execute the workfow as[optional]
scheduleStringcron string to determine when this runs[optional]
metaStringmetadata in any text format to be used in client code[optional]
versionLongversion number for optimistic locking (auto-incremented on each update)[optional] [readonly]
tasksList<Task>an array of Tasks to be performed
workflowStateList<WorkflowState>an array stateful objects to be used in the workflow[optional]
statusStatusEnumlast known status of the workflow[optional]
idUUIDUnique identifier for object in the system[optional] [readonly]
ownerIdUUIDUUID of owner of the object in the system[optional] [readonly]
createdDateOffsetDateTimeDate of object creation[optional] [readonly]
keyHashStringData, including hash of the key(s) used to encrypt this record.[optional] [readonly]
lastAccessedByIdUUIDLast user to access object[optional] [readonly]
lastAccessedDateOffsetDateTimeTimestamp of last access of object[optional] [readonly]
lastModifiedByIdUUIDUnique identifier for user who last modifed the object in the system[optional] [readonly]
lastModifiedDateOffsetDateTimeDate of last object modification[optional] [readonly]

Enum: RoleEnum

NameValue
USER"user"
ASSISTANT"assistant"
SYSTEM"system"

Enum: StatusEnum

NameValue
RUNNING"running"
STOPPED"stopped"
PAUSED"paused"
READY"ready"
WARNING"warning"
ERROR"error"
DISABLED"disabled"

Implemented Interfaces

  • Serializable

Generated Version Details

~value
GENERATOR VERSIONcom.valkyrlabs:ValkyrAI API 1.0.1-SNAPSHOT
API ARTIFACTcom.valkyrlabs.valkyrai-api.jar
GENERATOR VERSIONorg.openapitools.openapi-generator:7.5.0
GENERATOR CLASSorg.openapitools.codegen.languages.SpringCodegen
GENERATED DATE2025-12-03T11:13:18.492704-08:00[America/Los_Angeles]