Workflows
List
Get Tags
Update
Run
User Approval
Approve User
ModelsExpand Collapse
class WorkflowListResponse: …
flow: List[Flow]The flow of the workflow.
The flow of the workflow.
type: Literal["custom-model", "for-each", "generate-prompt", 7 more]The type of the job for the node.
The type of the job for the node.
Fixed number of iterations for a ForEach node.
When set, the loop runs exactly count times regardless of array input.
When not set, the loop iterates over the resolved array input.
Only available for ForEach nodes.
The nodes that this node depends on. Only available for nodes that have dependencies. Mainly used for user approval nodes.
If true, the outputs of this node will be included in the workflow job’s final output.
Only applicable to producing nodes (custom-model, inference, etc.).
By default, only last nodes (nodes not referenced by other nodes) contribute to outputs.
Set this to true to also include intermediate nodes in the final output.
Note: This should only be set to true or left undefined.
inputs: Optional[List[FlowInput]]The inputs of the node.
The inputs of the node.
The allowed values for the input. For `string` or `number` types, creates a single-select dropdown. For `string_array` type, creates a multi-select dropdown.
background_behavior: Optional[Literal["opaque", "transparent"]]Specifies the background behavior for the input. Only available for `file` and `file_array`
input types with kind `image`.
Specifies the background behavior for the input. Only available for `file` and `file_array` input types with kind `image`.
Help text displayed in the UI to provide additional information about the input
Used to visually group inputs together in the UI. Inputs with the same group value appear consecutively in the UI.
The list of inputs which form an object within a container array. All inputs are the same as the current object. This is only available for type inputs_array inputs.
items: Optional[List[List[FlowInputItem]]]The configured items for inputs_array type inputs.
Each item is an array of SubNodeInput that need ref/value resolution.
Only available for inputs_array type.
The configured items for inputs_array type inputs. Each item is an array of SubNodeInput that need ref/value resolution. Only available for inputs_array type.
The allowed values for the input. For `string` or `number` types, creates a single-select dropdown. For `string_array` type, creates a multi-select dropdown.
background_behavior: Optional[Literal["opaque", "transparent"]]Specifies the background behavior for the input. Only available for `file` and `file_array`
input types with kind `image`.
Specifies the background behavior for the input. Only available for `file` and `file_array` input types with kind `image`.
Help text displayed in the UI to provide additional information about the input
Used to visually group inputs together in the UI. Inputs with the same group value appear consecutively in the UI.
The list of inputs which form an object within a container array. All inputs are the same as the current object. This is only available for type inputs_array inputs.
kind: Optional[Literal["3d", "audio", "document", 4 more]]The asset kind of the input. Only taken into account for `file` and `file_array` input types.
If model provides multiple kinds,
the input will be not able to create the asset on the flight on API side with dataurl without data:kind, prefix
The asset kind of the input. Only taken into account for `file` and `file_array` input types. If model provides multiple kinds, the input will be not able to create the asset on the flight on API side with dataurl without data:kind, prefix
The maximum allowed length for `string` inputs. Also applies to each item in `string_array`.
The maximum allowed file size in bytes. Only applies to `file` and `file_array` input types. Validated against `asset.properties.size` at job creation time.
The minimum allowed length for string inputs. Also applies to each item in `string_array`.
model_types: Optional[List[Literal["custom", "elevenlabs-voice", "flux.1", 34 more]]]The allowed model types for this input. Example: `[“flux.1-lora”]`.
Only available for `model_array` input type.
The allowed model types for this input. Example: `[“flux.1-lora”]`. Only available for `model_array` input type.
Whether this input represents a parent asset to assign to the produced assets. Only available for `file` and `file_array` input types.
For `file_array`, the parent asset is the first item in the array.
Whether the input is a prompt. When true, displays as a text area with prompt spark feature. Only available for `string` input type.
Whether the input is used with prompt spark. Only available for `string` input type.
ref: Optional[FlowInputItemRef]The reference to another input or output of the same workflow.
Must have at least one of node or conditional.
The reference to another input or output of the same workflow. Must have at least one of node or conditional.
The conditional nodes to reference. If the conditional nodes are successful, the node will be successful. If the conditional nodes are skipped, the node will be skipped. Contains an array of node ids used to check the status of the nodes.
The name of the input or output to reference. If the type is ‘workflow’, the name is the name of the input of the workflow is required If the type is ‘node’, the name is not mandatory, except if you want all outputs of the node. To get all outputs of a node, you can use the name ‘all’.
required: Optional[FlowInputItemRequired]Set of rules that describes when this input is required:
- `always`: Input is always required
- `ifNotDefined`: Input is required when another specified input is not defined
- `ifDefined`: Input is required when another specified input is defined
- `conditionalValues`: Input is required when another input has a specific value
By default, the input is not required.
Set of rules that describes when this input is required:
- `always`: Input is always required
- `ifNotDefined`: Input is required when another specified input is not defined
- `ifDefined`: Input is required when another specified input is defined
- `conditionalValues`: Input is required when another input has a specific value
By default, the input is not required.
Makes this input required when another input has a specific value:
- Key: name of the input to check
- Value: operation and allowed values that trigger the requirement
kind: Optional[Literal["3d", "audio", "document", 4 more]]The asset kind of the input. Only taken into account for `file` and `file_array` input types.
If model provides multiple kinds,
the input will be not able to create the asset on the flight on API side with dataurl without data:kind, prefix
The asset kind of the input. Only taken into account for `file` and `file_array` input types. If model provides multiple kinds, the input will be not able to create the asset on the flight on API side with dataurl without data:kind, prefix
The maximum allowed length for `string` inputs. Also applies to each item in `string_array`.
The maximum allowed file size in bytes. Only applies to `file` and `file_array` input types. Validated against `asset.properties.size` at job creation time.
The minimum allowed length for string inputs. Also applies to each item in `string_array`.
model_types: Optional[List[Literal["custom", "elevenlabs-voice", "flux.1", 34 more]]]The allowed model types for this input. Example: `[“flux.1-lora”]`.
Only available for `model_array` input type.
The allowed model types for this input. Example: `[“flux.1-lora”]`. Only available for `model_array` input type.
Whether this input represents a parent asset to assign to the produced assets. Only available for `file` and `file_array` input types.
For `file_array`, the parent asset is the first item in the array.
Whether the input is a prompt. When true, displays as a text area with prompt spark feature. Only available for `string` input type.
Whether the input is used with prompt spark. Only available for `string` input type.
ref: Optional[FlowInputRef]The reference to another input or output of the same workflow.
Must have at least one of node or conditional.
The reference to another input or output of the same workflow. Must have at least one of node or conditional.
The conditional nodes to reference. If the conditional nodes are successful, the node will be successful. If the conditional nodes are skipped, the node will be skipped. Contains an array of node ids used to check the status of the nodes.
The name of the input or output to reference. If the type is ‘workflow’, the name is the name of the input of the workflow is required If the type is ‘node’, the name is not mandatory, except if you want all outputs of the node. To get all outputs of a node, you can use the name ‘all’.
required: Optional[FlowInputRequired]Set of rules that describes when this input is required:
- `always`: Input is always required
- `ifNotDefined`: Input is required when another specified input is not defined
- `ifDefined`: Input is required when another specified input is defined
- `conditionalValues`: Input is required when another input has a specific value
By default, the input is not required.
Set of rules that describes when this input is required:
- `always`: Input is always required
- `ifNotDefined`: Input is required when another specified input is not defined
- `ifDefined`: Input is required when another specified input is defined
- `conditionalValues`: Input is required when another input has a specific value
By default, the input is not required.
Makes this input required when another input has a specific value:
- Key: name of the input to check
- Value: operation and allowed values that trigger the requirement
Statically-configured items for a List node. The node outputs this array as-is when executed. Only available for List nodes. The values can be strings, numbers, or asset IDs.
Zero-based index of the iteration this node copy belongs to. Set on dynamically-created copies of loop body nodes.
logic: Optional[FlowLogic]The logic of the node.
Only available for logic nodes.
The logic of the node. Only available for logic nodes.
The type of the logic for the node. Only available for logic nodes.
IDs of the body template nodes that belong to this ForEach loop. At runtime these templates are cloned once per iteration and marked Skipped. Only available for ForEach nodes.
inputs: List[Input]The inputs of the workflow.
The inputs of the workflow.
The allowed values for the input. For `string` or `number` types, creates a single-select dropdown. For `string_array` type, creates a multi-select dropdown.
background_behavior: Optional[Literal["opaque", "transparent"]]Specifies the background behavior for the input. Only available for `file` and `file_array`
input types with kind `image`.
Specifies the background behavior for the input. Only available for `file` and `file_array` input types with kind `image`.
Help text displayed in the UI to provide additional information about the input
Used to visually group inputs together in the UI. Inputs with the same group value appear consecutively in the UI.
The list of inputs which form an object within a container array. All inputs are the same as the current object. This is only available for type inputs_array inputs.
kind: Optional[Literal["3d", "audio", "document", 4 more]]The asset kind of the input. Only taken into account for `file` and `file_array` input types.
If model provides multiple kinds,
the input will be not able to create the asset on the flight on API side with dataurl without data:kind, prefix
The asset kind of the input. Only taken into account for `file` and `file_array` input types. If model provides multiple kinds, the input will be not able to create the asset on the flight on API side with dataurl without data:kind, prefix
The maximum allowed length for `string` inputs. Also applies to each item in `string_array`.
The maximum allowed file size in bytes. Only applies to `file` and `file_array` input types. Validated against `asset.properties.size` at job creation time.
The minimum allowed length for string inputs. Also applies to each item in `string_array`.
model_types: Optional[List[Literal["custom", "elevenlabs-voice", "flux.1", 34 more]]]The allowed model types for this input. Example: `[“flux.1-lora”]`.
Only available for `model_array` input type.
The allowed model types for this input. Example: `[“flux.1-lora”]`. Only available for `model_array` input type.
Whether this input represents a parent asset to assign to the produced assets. Only available for `file` and `file_array` input types.
For `file_array`, the parent asset is the first item in the array.
Whether the input is a prompt. When true, displays as a text area with prompt spark feature. Only available for `string` input type.
Whether the input is used with prompt spark. Only available for `string` input type.
required: Optional[InputRequired]Set of rules that describes when this input is required:
- `always`: Input is always required
- `ifNotDefined`: Input is required when another specified input is not defined
- `ifDefined`: Input is required when another specified input is defined
- `conditionalValues`: Input is required when another input has a specific value
By default, the input is not required.
Set of rules that describes when this input is required:
- `always`: Input is always required
- `ifNotDefined`: Input is required when another specified input is not defined
- `ifDefined`: Input is required when another specified input is defined
- `conditionalValues`: Input is required when another input has a specific value
By default, the input is not required.
Makes this input required when another input has a specific value:
- Key: name of the input to check
- Value: operation and allowed values that trigger the requirement
Whether the workflow is locked. Locked workflows cannot be modified or deleted except by the author or a project admin.
last_indexing_type: Optional[Literal["CREATE", "DELETE", "UPDATE"]]The type of indexing operation to perform in MeiliSearch
The type of indexing operation to perform in MeiliSearch
Timestamp when the workflow flow was last saved as a Ready (App) snapshot. Used to compute the WorkflowNodes snapshot key. Only set for workflows that have been in the Ready state.
output_asset_kinds: Optional[List[Literal["3d", "audio", "document", 4 more]]]Asset kinds produced by this workflow (if specified).
Asset kinds produced by this workflow (if specified).
ui_config: Optional[UiConfig]The UI configuration for the workflow. This is managed by scenario webapp.
The UI configuration for the workflow. This is managed by scenario webapp.
input_properties: Optional[Dict[str, UiConfigInputProperties]]Configuration for the input properties
Configuration for the input properties
resolution_component: Optional[UiConfigResolutionComponent]Configuration for the resolution component
Configuration for the resolution component
class WorkflowCreateResponse: …
workflow: Workflow
flow: List[WorkflowFlow]The flow of the workflow.
The flow of the workflow.
type: Literal["custom-model", "for-each", "generate-prompt", 7 more]The type of the job for the node.
The type of the job for the node.
Fixed number of iterations for a ForEach node.
When set, the loop runs exactly count times regardless of array input.
When not set, the loop iterates over the resolved array input.
Only available for ForEach nodes.
The nodes that this node depends on. Only available for nodes that have dependencies. Mainly used for user approval nodes.
If true, the outputs of this node will be included in the workflow job’s final output.
Only applicable to producing nodes (custom-model, inference, etc.).
By default, only last nodes (nodes not referenced by other nodes) contribute to outputs.
Set this to true to also include intermediate nodes in the final output.
Note: This should only be set to true or left undefined.
inputs: Optional[List[WorkflowFlowInput]]The inputs of the node.
The inputs of the node.
The allowed values for the input. For `string` or `number` types, creates a single-select dropdown. For `string_array` type, creates a multi-select dropdown.
background_behavior: Optional[Literal["opaque", "transparent"]]Specifies the background behavior for the input. Only available for `file` and `file_array`
input types with kind `image`.
Specifies the background behavior for the input. Only available for `file` and `file_array` input types with kind `image`.
Help text displayed in the UI to provide additional information about the input
Used to visually group inputs together in the UI. Inputs with the same group value appear consecutively in the UI.
The list of inputs which form an object within a container array. All inputs are the same as the current object. This is only available for type inputs_array inputs.
items: Optional[List[List[WorkflowFlowInputItem]]]The configured items for inputs_array type inputs.
Each item is an array of SubNodeInput that need ref/value resolution.
Only available for inputs_array type.
The configured items for inputs_array type inputs. Each item is an array of SubNodeInput that need ref/value resolution. Only available for inputs_array type.
The allowed values for the input. For `string` or `number` types, creates a single-select dropdown. For `string_array` type, creates a multi-select dropdown.
background_behavior: Optional[Literal["opaque", "transparent"]]Specifies the background behavior for the input. Only available for `file` and `file_array`
input types with kind `image`.
Specifies the background behavior for the input. Only available for `file` and `file_array` input types with kind `image`.
Help text displayed in the UI to provide additional information about the input
Used to visually group inputs together in the UI. Inputs with the same group value appear consecutively in the UI.
The list of inputs which form an object within a container array. All inputs are the same as the current object. This is only available for type inputs_array inputs.
kind: Optional[Literal["3d", "audio", "document", 4 more]]The asset kind of the input. Only taken into account for `file` and `file_array` input types.
If model provides multiple kinds,
the input will be not able to create the asset on the flight on API side with dataurl without data:kind, prefix
The asset kind of the input. Only taken into account for `file` and `file_array` input types. If model provides multiple kinds, the input will be not able to create the asset on the flight on API side with dataurl without data:kind, prefix
The maximum allowed length for `string` inputs. Also applies to each item in `string_array`.
The maximum allowed file size in bytes. Only applies to `file` and `file_array` input types. Validated against `asset.properties.size` at job creation time.
The minimum allowed length for string inputs. Also applies to each item in `string_array`.
model_types: Optional[List[Literal["custom", "elevenlabs-voice", "flux.1", 34 more]]]The allowed model types for this input. Example: `[“flux.1-lora”]`.
Only available for `model_array` input type.
The allowed model types for this input. Example: `[“flux.1-lora”]`. Only available for `model_array` input type.
Whether this input represents a parent asset to assign to the produced assets. Only available for `file` and `file_array` input types.
For `file_array`, the parent asset is the first item in the array.
Whether the input is a prompt. When true, displays as a text area with prompt spark feature. Only available for `string` input type.
Whether the input is used with prompt spark. Only available for `string` input type.
ref: Optional[WorkflowFlowInputItemRef]The reference to another input or output of the same workflow.
Must have at least one of node or conditional.
The reference to another input or output of the same workflow. Must have at least one of node or conditional.
The conditional nodes to reference. If the conditional nodes are successful, the node will be successful. If the conditional nodes are skipped, the node will be skipped. Contains an array of node ids used to check the status of the nodes.
The name of the input or output to reference. If the type is ‘workflow’, the name is the name of the input of the workflow is required If the type is ‘node’, the name is not mandatory, except if you want all outputs of the node. To get all outputs of a node, you can use the name ‘all’.
required: Optional[WorkflowFlowInputItemRequired]Set of rules that describes when this input is required:
- `always`: Input is always required
- `ifNotDefined`: Input is required when another specified input is not defined
- `ifDefined`: Input is required when another specified input is defined
- `conditionalValues`: Input is required when another input has a specific value
By default, the input is not required.
Set of rules that describes when this input is required:
- `always`: Input is always required
- `ifNotDefined`: Input is required when another specified input is not defined
- `ifDefined`: Input is required when another specified input is defined
- `conditionalValues`: Input is required when another input has a specific value
By default, the input is not required.
Makes this input required when another input has a specific value:
- Key: name of the input to check
- Value: operation and allowed values that trigger the requirement
kind: Optional[Literal["3d", "audio", "document", 4 more]]The asset kind of the input. Only taken into account for `file` and `file_array` input types.
If model provides multiple kinds,
the input will be not able to create the asset on the flight on API side with dataurl without data:kind, prefix
The asset kind of the input. Only taken into account for `file` and `file_array` input types. If model provides multiple kinds, the input will be not able to create the asset on the flight on API side with dataurl without data:kind, prefix
The maximum allowed length for `string` inputs. Also applies to each item in `string_array`.
The maximum allowed file size in bytes. Only applies to `file` and `file_array` input types. Validated against `asset.properties.size` at job creation time.
The minimum allowed length for string inputs. Also applies to each item in `string_array`.
model_types: Optional[List[Literal["custom", "elevenlabs-voice", "flux.1", 34 more]]]The allowed model types for this input. Example: `[“flux.1-lora”]`.
Only available for `model_array` input type.
The allowed model types for this input. Example: `[“flux.1-lora”]`. Only available for `model_array` input type.
Whether this input represents a parent asset to assign to the produced assets. Only available for `file` and `file_array` input types.
For `file_array`, the parent asset is the first item in the array.
Whether the input is a prompt. When true, displays as a text area with prompt spark feature. Only available for `string` input type.
Whether the input is used with prompt spark. Only available for `string` input type.
ref: Optional[WorkflowFlowInputRef]The reference to another input or output of the same workflow.
Must have at least one of node or conditional.
The reference to another input or output of the same workflow. Must have at least one of node or conditional.
The conditional nodes to reference. If the conditional nodes are successful, the node will be successful. If the conditional nodes are skipped, the node will be skipped. Contains an array of node ids used to check the status of the nodes.
The name of the input or output to reference. If the type is ‘workflow’, the name is the name of the input of the workflow is required If the type is ‘node’, the name is not mandatory, except if you want all outputs of the node. To get all outputs of a node, you can use the name ‘all’.
required: Optional[WorkflowFlowInputRequired]Set of rules that describes when this input is required:
- `always`: Input is always required
- `ifNotDefined`: Input is required when another specified input is not defined
- `ifDefined`: Input is required when another specified input is defined
- `conditionalValues`: Input is required when another input has a specific value
By default, the input is not required.
Set of rules that describes when this input is required:
- `always`: Input is always required
- `ifNotDefined`: Input is required when another specified input is not defined
- `ifDefined`: Input is required when another specified input is defined
- `conditionalValues`: Input is required when another input has a specific value
By default, the input is not required.
Makes this input required when another input has a specific value:
- Key: name of the input to check
- Value: operation and allowed values that trigger the requirement
Statically-configured items for a List node. The node outputs this array as-is when executed. Only available for List nodes. The values can be strings, numbers, or asset IDs.
Zero-based index of the iteration this node copy belongs to. Set on dynamically-created copies of loop body nodes.
logic: Optional[WorkflowFlowLogic]The logic of the node.
Only available for logic nodes.
The logic of the node. Only available for logic nodes.
The type of the logic for the node. Only available for logic nodes.
IDs of the body template nodes that belong to this ForEach loop. At runtime these templates are cloned once per iteration and marked Skipped. Only available for ForEach nodes.
inputs: List[WorkflowInput]The inputs of the workflow.
The inputs of the workflow.
The allowed values for the input. For `string` or `number` types, creates a single-select dropdown. For `string_array` type, creates a multi-select dropdown.
background_behavior: Optional[Literal["opaque", "transparent"]]Specifies the background behavior for the input. Only available for `file` and `file_array`
input types with kind `image`.
Specifies the background behavior for the input. Only available for `file` and `file_array` input types with kind `image`.
Help text displayed in the UI to provide additional information about the input
Used to visually group inputs together in the UI. Inputs with the same group value appear consecutively in the UI.
The list of inputs which form an object within a container array. All inputs are the same as the current object. This is only available for type inputs_array inputs.
kind: Optional[Literal["3d", "audio", "document", 4 more]]The asset kind of the input. Only taken into account for `file` and `file_array` input types.
If model provides multiple kinds,
the input will be not able to create the asset on the flight on API side with dataurl without data:kind, prefix
The asset kind of the input. Only taken into account for `file` and `file_array` input types. If model provides multiple kinds, the input will be not able to create the asset on the flight on API side with dataurl without data:kind, prefix
The maximum allowed length for `string` inputs. Also applies to each item in `string_array`.
The maximum allowed file size in bytes. Only applies to `file` and `file_array` input types. Validated against `asset.properties.size` at job creation time.
The minimum allowed length for string inputs. Also applies to each item in `string_array`.
model_types: Optional[List[Literal["custom", "elevenlabs-voice", "flux.1", 34 more]]]The allowed model types for this input. Example: `[“flux.1-lora”]`.
Only available for `model_array` input type.
The allowed model types for this input. Example: `[“flux.1-lora”]`. Only available for `model_array` input type.
Whether this input represents a parent asset to assign to the produced assets. Only available for `file` and `file_array` input types.
For `file_array`, the parent asset is the first item in the array.
Whether the input is a prompt. When true, displays as a text area with prompt spark feature. Only available for `string` input type.
Whether the input is used with prompt spark. Only available for `string` input type.
required: Optional[WorkflowInputRequired]Set of rules that describes when this input is required:
- `always`: Input is always required
- `ifNotDefined`: Input is required when another specified input is not defined
- `ifDefined`: Input is required when another specified input is defined
- `conditionalValues`: Input is required when another input has a specific value
By default, the input is not required.
Set of rules that describes when this input is required:
- `always`: Input is always required
- `ifNotDefined`: Input is required when another specified input is not defined
- `ifDefined`: Input is required when another specified input is defined
- `conditionalValues`: Input is required when another input has a specific value
By default, the input is not required.
Makes this input required when another input has a specific value:
- Key: name of the input to check
- Value: operation and allowed values that trigger the requirement
Whether the workflow is locked. Locked workflows cannot be modified or deleted except by the author or a project admin.
last_indexing_type: Optional[Literal["CREATE", "DELETE", "UPDATE"]]The type of indexing operation to perform in MeiliSearch
The type of indexing operation to perform in MeiliSearch
Timestamp when the workflow flow was last saved as a Ready (App) snapshot. Used to compute the WorkflowNodes snapshot key. Only set for workflows that have been in the Ready state.
output_asset_kinds: Optional[List[Literal["3d", "audio", "document", 4 more]]]Asset kinds produced by this workflow (if specified).
Asset kinds produced by this workflow (if specified).
ui_config: Optional[WorkflowUiConfig]The UI configuration for the workflow. This is managed by scenario webapp.
The UI configuration for the workflow. This is managed by scenario webapp.
input_properties: Optional[Dict[str, WorkflowUiConfigInputProperties]]Configuration for the input properties
Configuration for the input properties
resolution_component: Optional[WorkflowUiConfigResolutionComponent]Configuration for the resolution component
Configuration for the resolution component
class WorkflowRetrieveResponse: …
workflow: Workflow
flow: List[WorkflowFlow]The flow of the workflow.
The flow of the workflow.
type: Literal["custom-model", "for-each", "generate-prompt", 7 more]The type of the job for the node.
The type of the job for the node.
Fixed number of iterations for a ForEach node.
When set, the loop runs exactly count times regardless of array input.
When not set, the loop iterates over the resolved array input.
Only available for ForEach nodes.
The nodes that this node depends on. Only available for nodes that have dependencies. Mainly used for user approval nodes.
If true, the outputs of this node will be included in the workflow job’s final output.
Only applicable to producing nodes (custom-model, inference, etc.).
By default, only last nodes (nodes not referenced by other nodes) contribute to outputs.
Set this to true to also include intermediate nodes in the final output.
Note: This should only be set to true or left undefined.
inputs: Optional[List[WorkflowFlowInput]]The inputs of the node.
The inputs of the node.
The allowed values for the input. For `string` or `number` types, creates a single-select dropdown. For `string_array` type, creates a multi-select dropdown.
background_behavior: Optional[Literal["opaque", "transparent"]]Specifies the background behavior for the input. Only available for `file` and `file_array`
input types with kind `image`.
Specifies the background behavior for the input. Only available for `file` and `file_array` input types with kind `image`.
Help text displayed in the UI to provide additional information about the input
Used to visually group inputs together in the UI. Inputs with the same group value appear consecutively in the UI.
The list of inputs which form an object within a container array. All inputs are the same as the current object. This is only available for type inputs_array inputs.
items: Optional[List[List[WorkflowFlowInputItem]]]The configured items for inputs_array type inputs.
Each item is an array of SubNodeInput that need ref/value resolution.
Only available for inputs_array type.
The configured items for inputs_array type inputs. Each item is an array of SubNodeInput that need ref/value resolution. Only available for inputs_array type.
The allowed values for the input. For `string` or `number` types, creates a single-select dropdown. For `string_array` type, creates a multi-select dropdown.
background_behavior: Optional[Literal["opaque", "transparent"]]Specifies the background behavior for the input. Only available for `file` and `file_array`
input types with kind `image`.
Specifies the background behavior for the input. Only available for `file` and `file_array` input types with kind `image`.
Help text displayed in the UI to provide additional information about the input
Used to visually group inputs together in the UI. Inputs with the same group value appear consecutively in the UI.
The list of inputs which form an object within a container array. All inputs are the same as the current object. This is only available for type inputs_array inputs.
kind: Optional[Literal["3d", "audio", "document", 4 more]]The asset kind of the input. Only taken into account for `file` and `file_array` input types.
If model provides multiple kinds,
the input will be not able to create the asset on the flight on API side with dataurl without data:kind, prefix
The asset kind of the input. Only taken into account for `file` and `file_array` input types. If model provides multiple kinds, the input will be not able to create the asset on the flight on API side with dataurl without data:kind, prefix
The maximum allowed length for `string` inputs. Also applies to each item in `string_array`.
The maximum allowed file size in bytes. Only applies to `file` and `file_array` input types. Validated against `asset.properties.size` at job creation time.
The minimum allowed length for string inputs. Also applies to each item in `string_array`.
model_types: Optional[List[Literal["custom", "elevenlabs-voice", "flux.1", 34 more]]]The allowed model types for this input. Example: `[“flux.1-lora”]`.
Only available for `model_array` input type.
The allowed model types for this input. Example: `[“flux.1-lora”]`. Only available for `model_array` input type.
Whether this input represents a parent asset to assign to the produced assets. Only available for `file` and `file_array` input types.
For `file_array`, the parent asset is the first item in the array.
Whether the input is a prompt. When true, displays as a text area with prompt spark feature. Only available for `string` input type.
Whether the input is used with prompt spark. Only available for `string` input type.
ref: Optional[WorkflowFlowInputItemRef]The reference to another input or output of the same workflow.
Must have at least one of node or conditional.
The reference to another input or output of the same workflow. Must have at least one of node or conditional.
The conditional nodes to reference. If the conditional nodes are successful, the node will be successful. If the conditional nodes are skipped, the node will be skipped. Contains an array of node ids used to check the status of the nodes.
The name of the input or output to reference. If the type is ‘workflow’, the name is the name of the input of the workflow is required If the type is ‘node’, the name is not mandatory, except if you want all outputs of the node. To get all outputs of a node, you can use the name ‘all’.
required: Optional[WorkflowFlowInputItemRequired]Set of rules that describes when this input is required:
- `always`: Input is always required
- `ifNotDefined`: Input is required when another specified input is not defined
- `ifDefined`: Input is required when another specified input is defined
- `conditionalValues`: Input is required when another input has a specific value
By default, the input is not required.
Set of rules that describes when this input is required:
- `always`: Input is always required
- `ifNotDefined`: Input is required when another specified input is not defined
- `ifDefined`: Input is required when another specified input is defined
- `conditionalValues`: Input is required when another input has a specific value
By default, the input is not required.
Makes this input required when another input has a specific value:
- Key: name of the input to check
- Value: operation and allowed values that trigger the requirement
kind: Optional[Literal["3d", "audio", "document", 4 more]]The asset kind of the input. Only taken into account for `file` and `file_array` input types.
If model provides multiple kinds,
the input will be not able to create the asset on the flight on API side with dataurl without data:kind, prefix
The asset kind of the input. Only taken into account for `file` and `file_array` input types. If model provides multiple kinds, the input will be not able to create the asset on the flight on API side with dataurl without data:kind, prefix
The maximum allowed length for `string` inputs. Also applies to each item in `string_array`.
The maximum allowed file size in bytes. Only applies to `file` and `file_array` input types. Validated against `asset.properties.size` at job creation time.
The minimum allowed length for string inputs. Also applies to each item in `string_array`.
model_types: Optional[List[Literal["custom", "elevenlabs-voice", "flux.1", 34 more]]]The allowed model types for this input. Example: `[“flux.1-lora”]`.
Only available for `model_array` input type.
The allowed model types for this input. Example: `[“flux.1-lora”]`. Only available for `model_array` input type.
Whether this input represents a parent asset to assign to the produced assets. Only available for `file` and `file_array` input types.
For `file_array`, the parent asset is the first item in the array.
Whether the input is a prompt. When true, displays as a text area with prompt spark feature. Only available for `string` input type.
Whether the input is used with prompt spark. Only available for `string` input type.
ref: Optional[WorkflowFlowInputRef]The reference to another input or output of the same workflow.
Must have at least one of node or conditional.
The reference to another input or output of the same workflow. Must have at least one of node or conditional.
The conditional nodes to reference. If the conditional nodes are successful, the node will be successful. If the conditional nodes are skipped, the node will be skipped. Contains an array of node ids used to check the status of the nodes.
The name of the input or output to reference. If the type is ‘workflow’, the name is the name of the input of the workflow is required If the type is ‘node’, the name is not mandatory, except if you want all outputs of the node. To get all outputs of a node, you can use the name ‘all’.
required: Optional[WorkflowFlowInputRequired]Set of rules that describes when this input is required:
- `always`: Input is always required
- `ifNotDefined`: Input is required when another specified input is not defined
- `ifDefined`: Input is required when another specified input is defined
- `conditionalValues`: Input is required when another input has a specific value
By default, the input is not required.
Set of rules that describes when this input is required:
- `always`: Input is always required
- `ifNotDefined`: Input is required when another specified input is not defined
- `ifDefined`: Input is required when another specified input is defined
- `conditionalValues`: Input is required when another input has a specific value
By default, the input is not required.
Makes this input required when another input has a specific value:
- Key: name of the input to check
- Value: operation and allowed values that trigger the requirement
Statically-configured items for a List node. The node outputs this array as-is when executed. Only available for List nodes. The values can be strings, numbers, or asset IDs.
Zero-based index of the iteration this node copy belongs to. Set on dynamically-created copies of loop body nodes.
logic: Optional[WorkflowFlowLogic]The logic of the node.
Only available for logic nodes.
The logic of the node. Only available for logic nodes.
The type of the logic for the node. Only available for logic nodes.
IDs of the body template nodes that belong to this ForEach loop. At runtime these templates are cloned once per iteration and marked Skipped. Only available for ForEach nodes.
inputs: List[WorkflowInput]The inputs of the workflow.
The inputs of the workflow.
The allowed values for the input. For `string` or `number` types, creates a single-select dropdown. For `string_array` type, creates a multi-select dropdown.
background_behavior: Optional[Literal["opaque", "transparent"]]Specifies the background behavior for the input. Only available for `file` and `file_array`
input types with kind `image`.
Specifies the background behavior for the input. Only available for `file` and `file_array` input types with kind `image`.
Help text displayed in the UI to provide additional information about the input
Used to visually group inputs together in the UI. Inputs with the same group value appear consecutively in the UI.
The list of inputs which form an object within a container array. All inputs are the same as the current object. This is only available for type inputs_array inputs.
kind: Optional[Literal["3d", "audio", "document", 4 more]]The asset kind of the input. Only taken into account for `file` and `file_array` input types.
If model provides multiple kinds,
the input will be not able to create the asset on the flight on API side with dataurl without data:kind, prefix
The asset kind of the input. Only taken into account for `file` and `file_array` input types. If model provides multiple kinds, the input will be not able to create the asset on the flight on API side with dataurl without data:kind, prefix
The maximum allowed length for `string` inputs. Also applies to each item in `string_array`.
The maximum allowed file size in bytes. Only applies to `file` and `file_array` input types. Validated against `asset.properties.size` at job creation time.
The minimum allowed length for string inputs. Also applies to each item in `string_array`.
model_types: Optional[List[Literal["custom", "elevenlabs-voice", "flux.1", 34 more]]]The allowed model types for this input. Example: `[“flux.1-lora”]`.
Only available for `model_array` input type.
The allowed model types for this input. Example: `[“flux.1-lora”]`. Only available for `model_array` input type.
Whether this input represents a parent asset to assign to the produced assets. Only available for `file` and `file_array` input types.
For `file_array`, the parent asset is the first item in the array.
Whether the input is a prompt. When true, displays as a text area with prompt spark feature. Only available for `string` input type.
Whether the input is used with prompt spark. Only available for `string` input type.
required: Optional[WorkflowInputRequired]Set of rules that describes when this input is required:
- `always`: Input is always required
- `ifNotDefined`: Input is required when another specified input is not defined
- `ifDefined`: Input is required when another specified input is defined
- `conditionalValues`: Input is required when another input has a specific value
By default, the input is not required.
Set of rules that describes when this input is required:
- `always`: Input is always required
- `ifNotDefined`: Input is required when another specified input is not defined
- `ifDefined`: Input is required when another specified input is defined
- `conditionalValues`: Input is required when another input has a specific value
By default, the input is not required.
Makes this input required when another input has a specific value:
- Key: name of the input to check
- Value: operation and allowed values that trigger the requirement
Whether the workflow is locked. Locked workflows cannot be modified or deleted except by the author or a project admin.
last_indexing_type: Optional[Literal["CREATE", "DELETE", "UPDATE"]]The type of indexing operation to perform in MeiliSearch
The type of indexing operation to perform in MeiliSearch
Timestamp when the workflow flow was last saved as a Ready (App) snapshot. Used to compute the WorkflowNodes snapshot key. Only set for workflows that have been in the Ready state.
output_asset_kinds: Optional[List[Literal["3d", "audio", "document", 4 more]]]Asset kinds produced by this workflow (if specified).
Asset kinds produced by this workflow (if specified).
ui_config: Optional[WorkflowUiConfig]The UI configuration for the workflow. This is managed by scenario webapp.
The UI configuration for the workflow. This is managed by scenario webapp.
input_properties: Optional[Dict[str, WorkflowUiConfigInputProperties]]Configuration for the input properties
Configuration for the input properties
resolution_component: Optional[WorkflowUiConfigResolutionComponent]Configuration for the resolution component
Configuration for the resolution component
class WorkflowUpdateResponse: …
workflow: Workflow
flow: List[WorkflowFlow]The flow of the workflow.
The flow of the workflow.
type: Literal["custom-model", "for-each", "generate-prompt", 7 more]The type of the job for the node.
The type of the job for the node.
Fixed number of iterations for a ForEach node.
When set, the loop runs exactly count times regardless of array input.
When not set, the loop iterates over the resolved array input.
Only available for ForEach nodes.
The nodes that this node depends on. Only available for nodes that have dependencies. Mainly used for user approval nodes.
If true, the outputs of this node will be included in the workflow job’s final output.
Only applicable to producing nodes (custom-model, inference, etc.).
By default, only last nodes (nodes not referenced by other nodes) contribute to outputs.
Set this to true to also include intermediate nodes in the final output.
Note: This should only be set to true or left undefined.
inputs: Optional[List[WorkflowFlowInput]]The inputs of the node.
The inputs of the node.
The allowed values for the input. For `string` or `number` types, creates a single-select dropdown. For `string_array` type, creates a multi-select dropdown.
background_behavior: Optional[Literal["opaque", "transparent"]]Specifies the background behavior for the input. Only available for `file` and `file_array`
input types with kind `image`.
Specifies the background behavior for the input. Only available for `file` and `file_array` input types with kind `image`.
Help text displayed in the UI to provide additional information about the input
Used to visually group inputs together in the UI. Inputs with the same group value appear consecutively in the UI.
The list of inputs which form an object within a container array. All inputs are the same as the current object. This is only available for type inputs_array inputs.
items: Optional[List[List[WorkflowFlowInputItem]]]The configured items for inputs_array type inputs.
Each item is an array of SubNodeInput that need ref/value resolution.
Only available for inputs_array type.
The configured items for inputs_array type inputs. Each item is an array of SubNodeInput that need ref/value resolution. Only available for inputs_array type.
The allowed values for the input. For `string` or `number` types, creates a single-select dropdown. For `string_array` type, creates a multi-select dropdown.
background_behavior: Optional[Literal["opaque", "transparent"]]Specifies the background behavior for the input. Only available for `file` and `file_array`
input types with kind `image`.
Specifies the background behavior for the input. Only available for `file` and `file_array` input types with kind `image`.
Help text displayed in the UI to provide additional information about the input
Used to visually group inputs together in the UI. Inputs with the same group value appear consecutively in the UI.
The list of inputs which form an object within a container array. All inputs are the same as the current object. This is only available for type inputs_array inputs.
kind: Optional[Literal["3d", "audio", "document", 4 more]]The asset kind of the input. Only taken into account for `file` and `file_array` input types.
If model provides multiple kinds,
the input will be not able to create the asset on the flight on API side with dataurl without data:kind, prefix
The asset kind of the input. Only taken into account for `file` and `file_array` input types. If model provides multiple kinds, the input will be not able to create the asset on the flight on API side with dataurl without data:kind, prefix
The maximum allowed length for `string` inputs. Also applies to each item in `string_array`.
The maximum allowed file size in bytes. Only applies to `file` and `file_array` input types. Validated against `asset.properties.size` at job creation time.
The minimum allowed length for string inputs. Also applies to each item in `string_array`.
model_types: Optional[List[Literal["custom", "elevenlabs-voice", "flux.1", 34 more]]]The allowed model types for this input. Example: `[“flux.1-lora”]`.
Only available for `model_array` input type.
The allowed model types for this input. Example: `[“flux.1-lora”]`. Only available for `model_array` input type.
Whether this input represents a parent asset to assign to the produced assets. Only available for `file` and `file_array` input types.
For `file_array`, the parent asset is the first item in the array.
Whether the input is a prompt. When true, displays as a text area with prompt spark feature. Only available for `string` input type.
Whether the input is used with prompt spark. Only available for `string` input type.
ref: Optional[WorkflowFlowInputItemRef]The reference to another input or output of the same workflow.
Must have at least one of node or conditional.
The reference to another input or output of the same workflow. Must have at least one of node or conditional.
The conditional nodes to reference. If the conditional nodes are successful, the node will be successful. If the conditional nodes are skipped, the node will be skipped. Contains an array of node ids used to check the status of the nodes.
The name of the input or output to reference. If the type is ‘workflow’, the name is the name of the input of the workflow is required If the type is ‘node’, the name is not mandatory, except if you want all outputs of the node. To get all outputs of a node, you can use the name ‘all’.
required: Optional[WorkflowFlowInputItemRequired]Set of rules that describes when this input is required:
- `always`: Input is always required
- `ifNotDefined`: Input is required when another specified input is not defined
- `ifDefined`: Input is required when another specified input is defined
- `conditionalValues`: Input is required when another input has a specific value
By default, the input is not required.
Set of rules that describes when this input is required:
- `always`: Input is always required
- `ifNotDefined`: Input is required when another specified input is not defined
- `ifDefined`: Input is required when another specified input is defined
- `conditionalValues`: Input is required when another input has a specific value
By default, the input is not required.
Makes this input required when another input has a specific value:
- Key: name of the input to check
- Value: operation and allowed values that trigger the requirement
kind: Optional[Literal["3d", "audio", "document", 4 more]]The asset kind of the input. Only taken into account for `file` and `file_array` input types.
If model provides multiple kinds,
the input will be not able to create the asset on the flight on API side with dataurl without data:kind, prefix
The asset kind of the input. Only taken into account for `file` and `file_array` input types. If model provides multiple kinds, the input will be not able to create the asset on the flight on API side with dataurl without data:kind, prefix
The maximum allowed length for `string` inputs. Also applies to each item in `string_array`.
The maximum allowed file size in bytes. Only applies to `file` and `file_array` input types. Validated against `asset.properties.size` at job creation time.
The minimum allowed length for string inputs. Also applies to each item in `string_array`.
model_types: Optional[List[Literal["custom", "elevenlabs-voice", "flux.1", 34 more]]]The allowed model types for this input. Example: `[“flux.1-lora”]`.
Only available for `model_array` input type.
The allowed model types for this input. Example: `[“flux.1-lora”]`. Only available for `model_array` input type.
Whether this input represents a parent asset to assign to the produced assets. Only available for `file` and `file_array` input types.
For `file_array`, the parent asset is the first item in the array.
Whether the input is a prompt. When true, displays as a text area with prompt spark feature. Only available for `string` input type.
Whether the input is used with prompt spark. Only available for `string` input type.
ref: Optional[WorkflowFlowInputRef]The reference to another input or output of the same workflow.
Must have at least one of node or conditional.
The reference to another input or output of the same workflow. Must have at least one of node or conditional.
The conditional nodes to reference. If the conditional nodes are successful, the node will be successful. If the conditional nodes are skipped, the node will be skipped. Contains an array of node ids used to check the status of the nodes.
The name of the input or output to reference. If the type is ‘workflow’, the name is the name of the input of the workflow is required If the type is ‘node’, the name is not mandatory, except if you want all outputs of the node. To get all outputs of a node, you can use the name ‘all’.
required: Optional[WorkflowFlowInputRequired]Set of rules that describes when this input is required:
- `always`: Input is always required
- `ifNotDefined`: Input is required when another specified input is not defined
- `ifDefined`: Input is required when another specified input is defined
- `conditionalValues`: Input is required when another input has a specific value
By default, the input is not required.
Set of rules that describes when this input is required:
- `always`: Input is always required
- `ifNotDefined`: Input is required when another specified input is not defined
- `ifDefined`: Input is required when another specified input is defined
- `conditionalValues`: Input is required when another input has a specific value
By default, the input is not required.
Makes this input required when another input has a specific value:
- Key: name of the input to check
- Value: operation and allowed values that trigger the requirement
Statically-configured items for a List node. The node outputs this array as-is when executed. Only available for List nodes. The values can be strings, numbers, or asset IDs.
Zero-based index of the iteration this node copy belongs to. Set on dynamically-created copies of loop body nodes.
logic: Optional[WorkflowFlowLogic]The logic of the node.
Only available for logic nodes.
The logic of the node. Only available for logic nodes.
The type of the logic for the node. Only available for logic nodes.
IDs of the body template nodes that belong to this ForEach loop. At runtime these templates are cloned once per iteration and marked Skipped. Only available for ForEach nodes.
inputs: List[WorkflowInput]The inputs of the workflow.
The inputs of the workflow.
The allowed values for the input. For `string` or `number` types, creates a single-select dropdown. For `string_array` type, creates a multi-select dropdown.
background_behavior: Optional[Literal["opaque", "transparent"]]Specifies the background behavior for the input. Only available for `file` and `file_array`
input types with kind `image`.
Specifies the background behavior for the input. Only available for `file` and `file_array` input types with kind `image`.
Help text displayed in the UI to provide additional information about the input
Used to visually group inputs together in the UI. Inputs with the same group value appear consecutively in the UI.
The list of inputs which form an object within a container array. All inputs are the same as the current object. This is only available for type inputs_array inputs.
kind: Optional[Literal["3d", "audio", "document", 4 more]]The asset kind of the input. Only taken into account for `file` and `file_array` input types.
If model provides multiple kinds,
the input will be not able to create the asset on the flight on API side with dataurl without data:kind, prefix
The asset kind of the input. Only taken into account for `file` and `file_array` input types. If model provides multiple kinds, the input will be not able to create the asset on the flight on API side with dataurl without data:kind, prefix
The maximum allowed length for `string` inputs. Also applies to each item in `string_array`.
The maximum allowed file size in bytes. Only applies to `file` and `file_array` input types. Validated against `asset.properties.size` at job creation time.
The minimum allowed length for string inputs. Also applies to each item in `string_array`.
model_types: Optional[List[Literal["custom", "elevenlabs-voice", "flux.1", 34 more]]]The allowed model types for this input. Example: `[“flux.1-lora”]`.
Only available for `model_array` input type.
The allowed model types for this input. Example: `[“flux.1-lora”]`. Only available for `model_array` input type.
Whether this input represents a parent asset to assign to the produced assets. Only available for `file` and `file_array` input types.
For `file_array`, the parent asset is the first item in the array.
Whether the input is a prompt. When true, displays as a text area with prompt spark feature. Only available for `string` input type.
Whether the input is used with prompt spark. Only available for `string` input type.
required: Optional[WorkflowInputRequired]Set of rules that describes when this input is required:
- `always`: Input is always required
- `ifNotDefined`: Input is required when another specified input is not defined
- `ifDefined`: Input is required when another specified input is defined
- `conditionalValues`: Input is required when another input has a specific value
By default, the input is not required.
Set of rules that describes when this input is required:
- `always`: Input is always required
- `ifNotDefined`: Input is required when another specified input is not defined
- `ifDefined`: Input is required when another specified input is defined
- `conditionalValues`: Input is required when another input has a specific value
By default, the input is not required.
Makes this input required when another input has a specific value:
- Key: name of the input to check
- Value: operation and allowed values that trigger the requirement
Whether the workflow is locked. Locked workflows cannot be modified or deleted except by the author or a project admin.
last_indexing_type: Optional[Literal["CREATE", "DELETE", "UPDATE"]]The type of indexing operation to perform in MeiliSearch
The type of indexing operation to perform in MeiliSearch
Timestamp when the workflow flow was last saved as a Ready (App) snapshot. Used to compute the WorkflowNodes snapshot key. Only set for workflows that have been in the Ready state.
output_asset_kinds: Optional[List[Literal["3d", "audio", "document", 4 more]]]Asset kinds produced by this workflow (if specified).
Asset kinds produced by this workflow (if specified).
ui_config: Optional[WorkflowUiConfig]The UI configuration for the workflow. This is managed by scenario webapp.
The UI configuration for the workflow. This is managed by scenario webapp.
input_properties: Optional[Dict[str, WorkflowUiConfigInputProperties]]Configuration for the input properties
Configuration for the input properties
resolution_component: Optional[WorkflowUiConfigResolutionComponent]Configuration for the resolution component
Configuration for the resolution component
class WorkflowRunResponse: …
job: Job
job_type: Literal["assets-download", "canvas-export", "caption", 36 more]The type of job
The type of job
metadata: JobMetadataMetadata of the job with some additional information
Metadata of the job with some additional information
flow: Optional[List[JobMetadataFlow]]The flow of the job. Only available for workflow jobs.
The flow of the job. Only available for workflow jobs.
status: Literal["failure", "pending", "processing", 2 more]The status of the node. Only available for WorkflowJob nodes.
The status of the node. Only available for WorkflowJob nodes.
type: Literal["custom-model", "for-each", "generate-prompt", 7 more]The type of the job for the node.
The type of the job for the node.
Fixed number of iterations for a ForEach node.
When set, the loop runs exactly count times regardless of array input.
When not set, the loop iterates over the resolved array input.
Only available for ForEach nodes.
The nodes that this node depends on. Only available for nodes that have dependencies. Mainly used for user approval nodes.
If true, the outputs of this node will be included in the workflow job’s final output.
Only applicable to producing nodes (custom-model, inference, etc.).
By default, only last nodes (nodes not referenced by other nodes) contribute to outputs.
Set this to true to also include intermediate nodes in the final output.
Note: This should only be set to true or left undefined.
inputs: Optional[List[JobMetadataFlowInput]]The inputs of the node.
The inputs of the node.
The allowed values for the input. For `string` or `number` types, creates a single-select dropdown. For `string_array` type, creates a multi-select dropdown.
background_behavior: Optional[Literal["opaque", "transparent"]]Specifies the background behavior for the input. Only available for `file` and `file_array`
input types with kind `image`.
Specifies the background behavior for the input. Only available for `file` and `file_array` input types with kind `image`.
Help text displayed in the UI to provide additional information about the input
Used to visually group inputs together in the UI. Inputs with the same group value appear consecutively in the UI.
The list of inputs which form an object within a container array. All inputs are the same as the current object. This is only available for type inputs_array inputs.
items: Optional[List[List[JobMetadataFlowInputItem]]]The configured items for inputs_array type inputs.
Each item is an array of SubNodeInput that need ref/value resolution.
Only available for inputs_array type.
The configured items for inputs_array type inputs. Each item is an array of SubNodeInput that need ref/value resolution. Only available for inputs_array type.
The allowed values for the input. For `string` or `number` types, creates a single-select dropdown. For `string_array` type, creates a multi-select dropdown.
background_behavior: Optional[Literal["opaque", "transparent"]]Specifies the background behavior for the input. Only available for `file` and `file_array`
input types with kind `image`.
Specifies the background behavior for the input. Only available for `file` and `file_array` input types with kind `image`.
Help text displayed in the UI to provide additional information about the input
Used to visually group inputs together in the UI. Inputs with the same group value appear consecutively in the UI.
The list of inputs which form an object within a container array. All inputs are the same as the current object. This is only available for type inputs_array inputs.
kind: Optional[Literal["3d", "audio", "document", 4 more]]The asset kind of the input. Only taken into account for `file` and `file_array` input types.
If model provides multiple kinds,
the input will be not able to create the asset on the flight on API side with dataurl without data:kind, prefix
The asset kind of the input. Only taken into account for `file` and `file_array` input types. If model provides multiple kinds, the input will be not able to create the asset on the flight on API side with dataurl without data:kind, prefix
The maximum allowed length for `string` inputs. Also applies to each item in `string_array`.
The maximum allowed file size in bytes. Only applies to `file` and `file_array` input types. Validated against `asset.properties.size` at job creation time.
The minimum allowed length for string inputs. Also applies to each item in `string_array`.
model_types: Optional[List[Literal["custom", "elevenlabs-voice", "flux.1", 34 more]]]The allowed model types for this input. Example: `[“flux.1-lora”]`.
Only available for `model_array` input type.
The allowed model types for this input. Example: `[“flux.1-lora”]`. Only available for `model_array` input type.
Whether this input represents a parent asset to assign to the produced assets. Only available for `file` and `file_array` input types.
For `file_array`, the parent asset is the first item in the array.
Whether the input is a prompt. When true, displays as a text area with prompt spark feature. Only available for `string` input type.
Whether the input is used with prompt spark. Only available for `string` input type.
ref: Optional[JobMetadataFlowInputItemRef]The reference to another input or output of the same workflow.
Must have at least one of node or conditional.
The reference to another input or output of the same workflow. Must have at least one of node or conditional.
The conditional nodes to reference. If the conditional nodes are successful, the node will be successful. If the conditional nodes are skipped, the node will be skipped. Contains an array of node ids used to check the status of the nodes.
The name of the input or output to reference. If the type is ‘workflow’, the name is the name of the input of the workflow is required If the type is ‘node’, the name is not mandatory, except if you want all outputs of the node. To get all outputs of a node, you can use the name ‘all’.
required: Optional[JobMetadataFlowInputItemRequired]Set of rules that describes when this input is required:
- `always`: Input is always required
- `ifNotDefined`: Input is required when another specified input is not defined
- `ifDefined`: Input is required when another specified input is defined
- `conditionalValues`: Input is required when another input has a specific value
By default, the input is not required.
Set of rules that describes when this input is required:
- `always`: Input is always required
- `ifNotDefined`: Input is required when another specified input is not defined
- `ifDefined`: Input is required when another specified input is defined
- `conditionalValues`: Input is required when another input has a specific value
By default, the input is not required.
Makes this input required when another input has a specific value:
- Key: name of the input to check
- Value: operation and allowed values that trigger the requirement
kind: Optional[Literal["3d", "audio", "document", 4 more]]The asset kind of the input. Only taken into account for `file` and `file_array` input types.
If model provides multiple kinds,
the input will be not able to create the asset on the flight on API side with dataurl without data:kind, prefix
The asset kind of the input. Only taken into account for `file` and `file_array` input types. If model provides multiple kinds, the input will be not able to create the asset on the flight on API side with dataurl without data:kind, prefix
The maximum allowed length for `string` inputs. Also applies to each item in `string_array`.
The maximum allowed file size in bytes. Only applies to `file` and `file_array` input types. Validated against `asset.properties.size` at job creation time.
The minimum allowed length for string inputs. Also applies to each item in `string_array`.
model_types: Optional[List[Literal["custom", "elevenlabs-voice", "flux.1", 34 more]]]The allowed model types for this input. Example: `[“flux.1-lora”]`.
Only available for `model_array` input type.
The allowed model types for this input. Example: `[“flux.1-lora”]`. Only available for `model_array` input type.
Whether this input represents a parent asset to assign to the produced assets. Only available for `file` and `file_array` input types.
For `file_array`, the parent asset is the first item in the array.
Whether the input is a prompt. When true, displays as a text area with prompt spark feature. Only available for `string` input type.
Whether the input is used with prompt spark. Only available for `string` input type.
ref: Optional[JobMetadataFlowInputRef]The reference to another input or output of the same workflow.
Must have at least one of node or conditional.
The reference to another input or output of the same workflow. Must have at least one of node or conditional.
The conditional nodes to reference. If the conditional nodes are successful, the node will be successful. If the conditional nodes are skipped, the node will be skipped. Contains an array of node ids used to check the status of the nodes.
The name of the input or output to reference. If the type is ‘workflow’, the name is the name of the input of the workflow is required If the type is ‘node’, the name is not mandatory, except if you want all outputs of the node. To get all outputs of a node, you can use the name ‘all’.
required: Optional[JobMetadataFlowInputRequired]Set of rules that describes when this input is required:
- `always`: Input is always required
- `ifNotDefined`: Input is required when another specified input is not defined
- `ifDefined`: Input is required when another specified input is defined
- `conditionalValues`: Input is required when another input has a specific value
By default, the input is not required.
Set of rules that describes when this input is required:
- `always`: Input is always required
- `ifNotDefined`: Input is required when another specified input is not defined
- `ifDefined`: Input is required when another specified input is defined
- `conditionalValues`: Input is required when another input has a specific value
By default, the input is not required.
Makes this input required when another input has a specific value:
- Key: name of the input to check
- Value: operation and allowed values that trigger the requirement
Statically-configured items for a List node. The node outputs this array as-is when executed. Only available for List nodes. The values can be strings, numbers, or asset IDs.
Zero-based index of the iteration this node copy belongs to. Set on dynamically-created copies of loop body nodes.
If the flow is part of a WorkflowJob, this is the jobId for the node. jobId is only available for nodes started. A node “Pending” for a running workflow job is not started.
logic: Optional[JobMetadataFlowLogic]The logic of the node.
Only available for logic nodes.
The logic of the node. Only available for logic nodes.
The type of the logic for the node. Only available for logic nodes.
IDs of the body template nodes that belong to this ForEach loop. At runtime these templates are cloned once per iteration and marked Skipped. Only available for ForEach nodes.
workflow: Workflow
flow: List[WorkflowFlow]The flow of the workflow.
The flow of the workflow.
type: Literal["custom-model", "for-each", "generate-prompt", 7 more]The type of the job for the node.
The type of the job for the node.
Fixed number of iterations for a ForEach node.
When set, the loop runs exactly count times regardless of array input.
When not set, the loop iterates over the resolved array input.
Only available for ForEach nodes.
The nodes that this node depends on. Only available for nodes that have dependencies. Mainly used for user approval nodes.
If true, the outputs of this node will be included in the workflow job’s final output.
Only applicable to producing nodes (custom-model, inference, etc.).
By default, only last nodes (nodes not referenced by other nodes) contribute to outputs.
Set this to true to also include intermediate nodes in the final output.
Note: This should only be set to true or left undefined.
inputs: Optional[List[WorkflowFlowInput]]The inputs of the node.
The inputs of the node.
The allowed values for the input. For `string` or `number` types, creates a single-select dropdown. For `string_array` type, creates a multi-select dropdown.
background_behavior: Optional[Literal["opaque", "transparent"]]Specifies the background behavior for the input. Only available for `file` and `file_array`
input types with kind `image`.
Specifies the background behavior for the input. Only available for `file` and `file_array` input types with kind `image`.
Help text displayed in the UI to provide additional information about the input
Used to visually group inputs together in the UI. Inputs with the same group value appear consecutively in the UI.
The list of inputs which form an object within a container array. All inputs are the same as the current object. This is only available for type inputs_array inputs.
items: Optional[List[List[WorkflowFlowInputItem]]]The configured items for inputs_array type inputs.
Each item is an array of SubNodeInput that need ref/value resolution.
Only available for inputs_array type.
The configured items for inputs_array type inputs. Each item is an array of SubNodeInput that need ref/value resolution. Only available for inputs_array type.
The allowed values for the input. For `string` or `number` types, creates a single-select dropdown. For `string_array` type, creates a multi-select dropdown.
background_behavior: Optional[Literal["opaque", "transparent"]]Specifies the background behavior for the input. Only available for `file` and `file_array`
input types with kind `image`.
Specifies the background behavior for the input. Only available for `file` and `file_array` input types with kind `image`.
Help text displayed in the UI to provide additional information about the input
Used to visually group inputs together in the UI. Inputs with the same group value appear consecutively in the UI.
The list of inputs which form an object within a container array. All inputs are the same as the current object. This is only available for type inputs_array inputs.
kind: Optional[Literal["3d", "audio", "document", 4 more]]The asset kind of the input. Only taken into account for `file` and `file_array` input types.
If model provides multiple kinds,
the input will be not able to create the asset on the flight on API side with dataurl without data:kind, prefix
The asset kind of the input. Only taken into account for `file` and `file_array` input types. If model provides multiple kinds, the input will be not able to create the asset on the flight on API side with dataurl without data:kind, prefix
The maximum allowed length for `string` inputs. Also applies to each item in `string_array`.
The maximum allowed file size in bytes. Only applies to `file` and `file_array` input types. Validated against `asset.properties.size` at job creation time.
The minimum allowed length for string inputs. Also applies to each item in `string_array`.
model_types: Optional[List[Literal["custom", "elevenlabs-voice", "flux.1", 34 more]]]The allowed model types for this input. Example: `[“flux.1-lora”]`.
Only available for `model_array` input type.
The allowed model types for this input. Example: `[“flux.1-lora”]`. Only available for `model_array` input type.
Whether this input represents a parent asset to assign to the produced assets. Only available for `file` and `file_array` input types.
For `file_array`, the parent asset is the first item in the array.
Whether the input is a prompt. When true, displays as a text area with prompt spark feature. Only available for `string` input type.
Whether the input is used with prompt spark. Only available for `string` input type.
ref: Optional[WorkflowFlowInputItemRef]The reference to another input or output of the same workflow.
Must have at least one of node or conditional.
The reference to another input or output of the same workflow. Must have at least one of node or conditional.
The conditional nodes to reference. If the conditional nodes are successful, the node will be successful. If the conditional nodes are skipped, the node will be skipped. Contains an array of node ids used to check the status of the nodes.
The name of the input or output to reference. If the type is ‘workflow’, the name is the name of the input of the workflow is required If the type is ‘node’, the name is not mandatory, except if you want all outputs of the node. To get all outputs of a node, you can use the name ‘all’.
required: Optional[WorkflowFlowInputItemRequired]Set of rules that describes when this input is required:
- `always`: Input is always required
- `ifNotDefined`: Input is required when another specified input is not defined
- `ifDefined`: Input is required when another specified input is defined
- `conditionalValues`: Input is required when another input has a specific value
By default, the input is not required.
Set of rules that describes when this input is required:
- `always`: Input is always required
- `ifNotDefined`: Input is required when another specified input is not defined
- `ifDefined`: Input is required when another specified input is defined
- `conditionalValues`: Input is required when another input has a specific value
By default, the input is not required.
Makes this input required when another input has a specific value:
- Key: name of the input to check
- Value: operation and allowed values that trigger the requirement
kind: Optional[Literal["3d", "audio", "document", 4 more]]The asset kind of the input. Only taken into account for `file` and `file_array` input types.
If model provides multiple kinds,
the input will be not able to create the asset on the flight on API side with dataurl without data:kind, prefix
The asset kind of the input. Only taken into account for `file` and `file_array` input types. If model provides multiple kinds, the input will be not able to create the asset on the flight on API side with dataurl without data:kind, prefix
The maximum allowed length for `string` inputs. Also applies to each item in `string_array`.
The maximum allowed file size in bytes. Only applies to `file` and `file_array` input types. Validated against `asset.properties.size` at job creation time.
The minimum allowed length for string inputs. Also applies to each item in `string_array`.
model_types: Optional[List[Literal["custom", "elevenlabs-voice", "flux.1", 34 more]]]The allowed model types for this input. Example: `[“flux.1-lora”]`.
Only available for `model_array` input type.
The allowed model types for this input. Example: `[“flux.1-lora”]`. Only available for `model_array` input type.
Whether this input represents a parent asset to assign to the produced assets. Only available for `file` and `file_array` input types.
For `file_array`, the parent asset is the first item in the array.
Whether the input is a prompt. When true, displays as a text area with prompt spark feature. Only available for `string` input type.
Whether the input is used with prompt spark. Only available for `string` input type.
ref: Optional[WorkflowFlowInputRef]The reference to another input or output of the same workflow.
Must have at least one of node or conditional.
The reference to another input or output of the same workflow. Must have at least one of node or conditional.
The conditional nodes to reference. If the conditional nodes are successful, the node will be successful. If the conditional nodes are skipped, the node will be skipped. Contains an array of node ids used to check the status of the nodes.
The name of the input or output to reference. If the type is ‘workflow’, the name is the name of the input of the workflow is required If the type is ‘node’, the name is not mandatory, except if you want all outputs of the node. To get all outputs of a node, you can use the name ‘all’.
required: Optional[WorkflowFlowInputRequired]Set of rules that describes when this input is required:
- `always`: Input is always required
- `ifNotDefined`: Input is required when another specified input is not defined
- `ifDefined`: Input is required when another specified input is defined
- `conditionalValues`: Input is required when another input has a specific value
By default, the input is not required.
Set of rules that describes when this input is required:
- `always`: Input is always required
- `ifNotDefined`: Input is required when another specified input is not defined
- `ifDefined`: Input is required when another specified input is defined
- `conditionalValues`: Input is required when another input has a specific value
By default, the input is not required.
Makes this input required when another input has a specific value:
- Key: name of the input to check
- Value: operation and allowed values that trigger the requirement
Statically-configured items for a List node. The node outputs this array as-is when executed. Only available for List nodes. The values can be strings, numbers, or asset IDs.
Zero-based index of the iteration this node copy belongs to. Set on dynamically-created copies of loop body nodes.
logic: Optional[WorkflowFlowLogic]The logic of the node.
Only available for logic nodes.
The logic of the node. Only available for logic nodes.
The type of the logic for the node. Only available for logic nodes.
IDs of the body template nodes that belong to this ForEach loop. At runtime these templates are cloned once per iteration and marked Skipped. Only available for ForEach nodes.
inputs: List[WorkflowInput]The inputs of the workflow.
The inputs of the workflow.
The allowed values for the input. For `string` or `number` types, creates a single-select dropdown. For `string_array` type, creates a multi-select dropdown.
background_behavior: Optional[Literal["opaque", "transparent"]]Specifies the background behavior for the input. Only available for `file` and `file_array`
input types with kind `image`.
Specifies the background behavior for the input. Only available for `file` and `file_array` input types with kind `image`.
Help text displayed in the UI to provide additional information about the input
Used to visually group inputs together in the UI. Inputs with the same group value appear consecutively in the UI.
The list of inputs which form an object within a container array. All inputs are the same as the current object. This is only available for type inputs_array inputs.
kind: Optional[Literal["3d", "audio", "document", 4 more]]The asset kind of the input. Only taken into account for `file` and `file_array` input types.
If model provides multiple kinds,
the input will be not able to create the asset on the flight on API side with dataurl without data:kind, prefix
The asset kind of the input. Only taken into account for `file` and `file_array` input types. If model provides multiple kinds, the input will be not able to create the asset on the flight on API side with dataurl without data:kind, prefix
The maximum allowed length for `string` inputs. Also applies to each item in `string_array`.
The maximum allowed file size in bytes. Only applies to `file` and `file_array` input types. Validated against `asset.properties.size` at job creation time.
The minimum allowed length for string inputs. Also applies to each item in `string_array`.
model_types: Optional[List[Literal["custom", "elevenlabs-voice", "flux.1", 34 more]]]The allowed model types for this input. Example: `[“flux.1-lora”]`.
Only available for `model_array` input type.
The allowed model types for this input. Example: `[“flux.1-lora”]`. Only available for `model_array` input type.
Whether this input represents a parent asset to assign to the produced assets. Only available for `file` and `file_array` input types.
For `file_array`, the parent asset is the first item in the array.
Whether the input is a prompt. When true, displays as a text area with prompt spark feature. Only available for `string` input type.
Whether the input is used with prompt spark. Only available for `string` input type.
required: Optional[WorkflowInputRequired]Set of rules that describes when this input is required:
- `always`: Input is always required
- `ifNotDefined`: Input is required when another specified input is not defined
- `ifDefined`: Input is required when another specified input is defined
- `conditionalValues`: Input is required when another input has a specific value
By default, the input is not required.
Set of rules that describes when this input is required:
- `always`: Input is always required
- `ifNotDefined`: Input is required when another specified input is not defined
- `ifDefined`: Input is required when another specified input is defined
- `conditionalValues`: Input is required when another input has a specific value
By default, the input is not required.
Makes this input required when another input has a specific value:
- Key: name of the input to check
- Value: operation and allowed values that trigger the requirement
Whether the workflow is locked. Locked workflows cannot be modified or deleted except by the author or a project admin.
last_indexing_type: Optional[Literal["CREATE", "DELETE", "UPDATE"]]The type of indexing operation to perform in MeiliSearch
The type of indexing operation to perform in MeiliSearch
Timestamp when the workflow flow was last saved as a Ready (App) snapshot. Used to compute the WorkflowNodes snapshot key. Only set for workflows that have been in the Ready state.
output_asset_kinds: Optional[List[Literal["3d", "audio", "document", 4 more]]]Asset kinds produced by this workflow (if specified).
Asset kinds produced by this workflow (if specified).
ui_config: Optional[WorkflowUiConfig]The UI configuration for the workflow. This is managed by scenario webapp.
The UI configuration for the workflow. This is managed by scenario webapp.
input_properties: Optional[Dict[str, WorkflowUiConfigInputProperties]]Configuration for the input properties
Configuration for the input properties
resolution_component: Optional[WorkflowUiConfigResolutionComponent]Configuration for the resolution component
Configuration for the resolution component
class WorkflowUserApprovalResponse: …
job: Job
job_type: Literal["assets-download", "canvas-export", "caption", 36 more]The type of job
The type of job
metadata: JobMetadataMetadata of the job with some additional information
Metadata of the job with some additional information
flow: Optional[List[JobMetadataFlow]]The flow of the job. Only available for workflow jobs.
The flow of the job. Only available for workflow jobs.
status: Literal["failure", "pending", "processing", 2 more]The status of the node. Only available for WorkflowJob nodes.
The status of the node. Only available for WorkflowJob nodes.
type: Literal["custom-model", "for-each", "generate-prompt", 7 more]The type of the job for the node.
The type of the job for the node.
Fixed number of iterations for a ForEach node.
When set, the loop runs exactly count times regardless of array input.
When not set, the loop iterates over the resolved array input.
Only available for ForEach nodes.
The nodes that this node depends on. Only available for nodes that have dependencies. Mainly used for user approval nodes.
If true, the outputs of this node will be included in the workflow job’s final output.
Only applicable to producing nodes (custom-model, inference, etc.).
By default, only last nodes (nodes not referenced by other nodes) contribute to outputs.
Set this to true to also include intermediate nodes in the final output.
Note: This should only be set to true or left undefined.
inputs: Optional[List[JobMetadataFlowInput]]The inputs of the node.
The inputs of the node.
The allowed values for the input. For `string` or `number` types, creates a single-select dropdown. For `string_array` type, creates a multi-select dropdown.
background_behavior: Optional[Literal["opaque", "transparent"]]Specifies the background behavior for the input. Only available for `file` and `file_array`
input types with kind `image`.
Specifies the background behavior for the input. Only available for `file` and `file_array` input types with kind `image`.
Help text displayed in the UI to provide additional information about the input
Used to visually group inputs together in the UI. Inputs with the same group value appear consecutively in the UI.
The list of inputs which form an object within a container array. All inputs are the same as the current object. This is only available for type inputs_array inputs.
items: Optional[List[List[JobMetadataFlowInputItem]]]The configured items for inputs_array type inputs.
Each item is an array of SubNodeInput that need ref/value resolution.
Only available for inputs_array type.
The configured items for inputs_array type inputs. Each item is an array of SubNodeInput that need ref/value resolution. Only available for inputs_array type.
The allowed values for the input. For `string` or `number` types, creates a single-select dropdown. For `string_array` type, creates a multi-select dropdown.
background_behavior: Optional[Literal["opaque", "transparent"]]Specifies the background behavior for the input. Only available for `file` and `file_array`
input types with kind `image`.
Specifies the background behavior for the input. Only available for `file` and `file_array` input types with kind `image`.
Help text displayed in the UI to provide additional information about the input
Used to visually group inputs together in the UI. Inputs with the same group value appear consecutively in the UI.
The list of inputs which form an object within a container array. All inputs are the same as the current object. This is only available for type inputs_array inputs.
kind: Optional[Literal["3d", "audio", "document", 4 more]]The asset kind of the input. Only taken into account for `file` and `file_array` input types.
If model provides multiple kinds,
the input will be not able to create the asset on the flight on API side with dataurl without data:kind, prefix
The asset kind of the input. Only taken into account for `file` and `file_array` input types. If model provides multiple kinds, the input will be not able to create the asset on the flight on API side with dataurl without data:kind, prefix
The maximum allowed length for `string` inputs. Also applies to each item in `string_array`.
The maximum allowed file size in bytes. Only applies to `file` and `file_array` input types. Validated against `asset.properties.size` at job creation time.
The minimum allowed length for string inputs. Also applies to each item in `string_array`.
model_types: Optional[List[Literal["custom", "elevenlabs-voice", "flux.1", 34 more]]]The allowed model types for this input. Example: `[“flux.1-lora”]`.
Only available for `model_array` input type.
The allowed model types for this input. Example: `[“flux.1-lora”]`. Only available for `model_array` input type.
Whether this input represents a parent asset to assign to the produced assets. Only available for `file` and `file_array` input types.
For `file_array`, the parent asset is the first item in the array.
Whether the input is a prompt. When true, displays as a text area with prompt spark feature. Only available for `string` input type.
Whether the input is used with prompt spark. Only available for `string` input type.
ref: Optional[JobMetadataFlowInputItemRef]The reference to another input or output of the same workflow.
Must have at least one of node or conditional.
The reference to another input or output of the same workflow. Must have at least one of node or conditional.
The conditional nodes to reference. If the conditional nodes are successful, the node will be successful. If the conditional nodes are skipped, the node will be skipped. Contains an array of node ids used to check the status of the nodes.
The name of the input or output to reference. If the type is ‘workflow’, the name is the name of the input of the workflow is required If the type is ‘node’, the name is not mandatory, except if you want all outputs of the node. To get all outputs of a node, you can use the name ‘all’.
required: Optional[JobMetadataFlowInputItemRequired]Set of rules that describes when this input is required:
- `always`: Input is always required
- `ifNotDefined`: Input is required when another specified input is not defined
- `ifDefined`: Input is required when another specified input is defined
- `conditionalValues`: Input is required when another input has a specific value
By default, the input is not required.
Set of rules that describes when this input is required:
- `always`: Input is always required
- `ifNotDefined`: Input is required when another specified input is not defined
- `ifDefined`: Input is required when another specified input is defined
- `conditionalValues`: Input is required when another input has a specific value
By default, the input is not required.
Makes this input required when another input has a specific value:
- Key: name of the input to check
- Value: operation and allowed values that trigger the requirement
kind: Optional[Literal["3d", "audio", "document", 4 more]]The asset kind of the input. Only taken into account for `file` and `file_array` input types.
If model provides multiple kinds,
the input will be not able to create the asset on the flight on API side with dataurl without data:kind, prefix
The asset kind of the input. Only taken into account for `file` and `file_array` input types. If model provides multiple kinds, the input will be not able to create the asset on the flight on API side with dataurl without data:kind, prefix
The maximum allowed length for `string` inputs. Also applies to each item in `string_array`.
The maximum allowed file size in bytes. Only applies to `file` and `file_array` input types. Validated against `asset.properties.size` at job creation time.
The minimum allowed length for string inputs. Also applies to each item in `string_array`.
model_types: Optional[List[Literal["custom", "elevenlabs-voice", "flux.1", 34 more]]]The allowed model types for this input. Example: `[“flux.1-lora”]`.
Only available for `model_array` input type.
The allowed model types for this input. Example: `[“flux.1-lora”]`. Only available for `model_array` input type.
Whether this input represents a parent asset to assign to the produced assets. Only available for `file` and `file_array` input types.
For `file_array`, the parent asset is the first item in the array.
Whether the input is a prompt. When true, displays as a text area with prompt spark feature. Only available for `string` input type.
Whether the input is used with prompt spark. Only available for `string` input type.
ref: Optional[JobMetadataFlowInputRef]The reference to another input or output of the same workflow.
Must have at least one of node or conditional.
The reference to another input or output of the same workflow. Must have at least one of node or conditional.
The conditional nodes to reference. If the conditional nodes are successful, the node will be successful. If the conditional nodes are skipped, the node will be skipped. Contains an array of node ids used to check the status of the nodes.
The name of the input or output to reference. If the type is ‘workflow’, the name is the name of the input of the workflow is required If the type is ‘node’, the name is not mandatory, except if you want all outputs of the node. To get all outputs of a node, you can use the name ‘all’.
required: Optional[JobMetadataFlowInputRequired]Set of rules that describes when this input is required:
- `always`: Input is always required
- `ifNotDefined`: Input is required when another specified input is not defined
- `ifDefined`: Input is required when another specified input is defined
- `conditionalValues`: Input is required when another input has a specific value
By default, the input is not required.
Set of rules that describes when this input is required:
- `always`: Input is always required
- `ifNotDefined`: Input is required when another specified input is not defined
- `ifDefined`: Input is required when another specified input is defined
- `conditionalValues`: Input is required when another input has a specific value
By default, the input is not required.
Makes this input required when another input has a specific value:
- Key: name of the input to check
- Value: operation and allowed values that trigger the requirement
Statically-configured items for a List node. The node outputs this array as-is when executed. Only available for List nodes. The values can be strings, numbers, or asset IDs.
Zero-based index of the iteration this node copy belongs to. Set on dynamically-created copies of loop body nodes.
If the flow is part of a WorkflowJob, this is the jobId for the node. jobId is only available for nodes started. A node “Pending” for a running workflow job is not started.
logic: Optional[JobMetadataFlowLogic]The logic of the node.
Only available for logic nodes.
The logic of the node. Only available for logic nodes.
The type of the logic for the node. Only available for logic nodes.
IDs of the body template nodes that belong to this ForEach loop. At runtime these templates are cloned once per iteration and marked Skipped. Only available for ForEach nodes.