CreateWorkflowDefinitionRequest.md

CreateWorkflowDefinitionRequest

Create a new workflow definition. Inputs are per-run (see POST /workflow-definitions/{id}/runs) so only the instruction lives on the definition. instruction_path_part_id is a DOCUMENT path_part.

Properties

Name	Type	Description	Notes
name	str
description	str		[optional]
max_run_duration_seconds	int		[optional] [default to 1800]
parent_path_part_id	UUID	The ``path_part_id`` of the folder the workflow is created under (the folder's PathPart id, not the Folder PDO id). The caller needs write access to it; the workflow may live anywhere in the path tree.
instruction_path_part_id	UUID	DOCUMENT path_part of the instruction document. Omit (or pass null) to have the server auto-create an empty instruction.md.	[optional]
approval_required	bool
is_template	bool	Create a non-runnable template. Templates are excluded from the default list and cannot have runs; users instantiate them into their own runnable workflow. Immutable after creation.	[optional] [default to False]
selected_skill_ids	List[UUID]	Skill PDO ids force-loaded into every run of this workflow by default (prefill). Each run inherits these and may add more; the agent can still discover others via search. Each must be a SKILL the caller can read.	[optional]
common_file_path_part_ids	List[UUID]	Optional path_part ids of common files (DOCUMENT / FOLDER / DATA_SOURCE / API_CONNECTION) attached to every run of this workflow — e.g. an output template. Merged with each run's own inputs at Start. The caller must be able to read each one.	[optional]

Example

from ksapi.models.create_workflow_definition_request import CreateWorkflowDefinitionRequest

# TODO update the JSON string below
json = "{}"
# create an instance of CreateWorkflowDefinitionRequest from a JSON string
create_workflow_definition_request_instance = CreateWorkflowDefinitionRequest.from_json(json)
# print the JSON string representation of the object
print(CreateWorkflowDefinitionRequest.to_json())

# convert the object into a dict
create_workflow_definition_request_dict = create_workflow_definition_request_instance.to_dict()
# create an instance of CreateWorkflowDefinitionRequest from a dict
create_workflow_definition_request_from_dict = CreateWorkflowDefinitionRequest.from_dict(create_workflow_definition_request_dict)

[Back to Model list] [Back to API list] [Back to README]