Tasks

TasksService

Service for managing UiPath Action Center tasks.

Tasks are task-based automation components that can be integrated into applications and processes. They represent discrete units of work that can be triggered and monitored through the UiPath API.

This service provides methods to create and retrieve tasks, supporting both app-specific and generic tasks. It inherits folder context management capabilities from FolderContext.

Reference: https://docs.uipath.com/automation-cloud/docs/actions

create

create(
    title,
    data=None,
    *,
    app_name=None,
    app_key=None,
    app_folder_path=None,
    app_folder_key=None,
    assignee=None,
    recipient=None,
    priority=None,
    labels=None,
    is_actionable_message_enabled=None,
    actionable_message_metadata=None,
    source_name="Agent",
)

Creates a new task synchronously.

This method creates a new action task in UiPath Orchestrator. The action can be either app-specific (using app_name or app_key) or a generic action.

Parameters:

Name	Type	Description	Default
title	str	The title of the action	required
data	dict[str, Any] | None	Optional dictionary containing input data for the action	None
app_name	str | None	The name of the application (if creating an app-specific action)	None
app_key	str | None	The key of the application (if creating an app-specific action)	None
app_folder_path	str | None	Optional folder path for the action	None
app_folder_key	str | None	Optional folder key for the action	None
assignee	str | None	Optional username or email to assign the task to	None
priority	str | None	Optional priority of the task	None
labels	list[str] | None	Optional list of labels for the task	None
is_actionable_message_enabled	bool | None	Optional boolean indicating whether actionable notifications are enabled for this task	None
actionable_message_metadata	dict[str, Any] | None	Optional metadata for the action	None
source_name	str	The name of the source that created the task. Defaults to 'Agent'.	'Agent'

Returns:

Name	Type	Description
Action	Task	The created action object

Raises:

Type	Description
Exception	If neither app_name nor app_key is provided for app-specific actions

create_async async

create_async(
    title,
    data=None,
    *,
    app_name=None,
    app_key=None,
    app_folder_path=None,
    app_folder_key=None,
    assignee=None,
    recipient=None,
    priority=None,
    labels=None,
    is_actionable_message_enabled=None,
    actionable_message_metadata=None,
    source_name="Agent",
)

Creates a new action asynchronously.

This method creates a new action task in UiPath Orchestrator. The action can be either app-specific (using app_name or app_key) or a generic action.

Parameters:

Name	Type	Description	Default
title	str	The title of the action	required
data	dict[str, Any] | None	Optional dictionary containing input data for the action	None
app_name	str | None	The name of the application (if creating an app-specific action)	None
app_key	str | None	The key of the application (if creating an app-specific action)	None
app_folder_path	str | None	Optional folder path for the action	None
app_folder_key	str | None	Optional folder key for the action	None
assignee	str | None	Optional username or email to assign the task to	None
priority	str | None	Optional priority of the task	None
labels	list[str] | None	Optional list of labels for the task	None
is_actionable_message_enabled	bool | None	Optional boolean indicating whether actionable notifications are enabled for this task	None
actionable_message_metadata	dict[str, Any] | None	Optional metadata for the action	None
source_name	str	The name of the source that created the task. Defaults to 'Agent'.	'Agent'

Returns:

Name	Type	Description
Action	Task	The created action object

Raises:

Type	Description
Exception	If neither app_name nor app_key is provided for app-specific actions

create_quickform

create_quickform(
    title,
    task_schema_key,
    schema,
    data=None,
    *,
    folder_path=None,
    folder_key=None,
    assignee=None,
    recipient=None,
    priority=None,
    labels=None,
    is_actionable_message_enabled=None,
    actionable_message_metadata=None,
    creator_job_key=None,
    source_name="Agent",
)

Create a new QuickForm task synchronously.

See :meth:create_quickform_async for parameter docs.

create_quickform_async async

create_quickform_async(
    title,
    task_schema_key,
    schema,
    data=None,
    *,
    folder_path=None,
    folder_key=None,
    assignee=None,
    recipient=None,
    priority=None,
    labels=None,
    is_actionable_message_enabled=None,
    actionable_message_metadata=None,
    creator_job_key=None,
    source_name="Agent",
)

Creates a new QuickForm task asynchronously.

QuickForm tasks are schema-first HITL tasks rendered by FormLib in Action Center. Both task_schema_key AND schema are required: the Agents runtime does not pre-populate TaskSchemas via a package.uploaded subscriber, so Orchestrator upserts the schema (keyed by task_schema_key) and creates the task in the same call.

Parameters:

Name	Type	Description	Default
title	str	The title of the task.	required
task_schema_key	str	UUID key of the schema. Used as the key under which Orchestrator stores/looks up the schema in TaskSchemas.	required
schema	dict[str, Any]	The HITL schema body to register/upsert. Sent inline on every call.	required
data	dict[str, Any] | None	Optional dictionary containing input data for the task.	None
folder_path	str | None	Optional folder path for the task. Required by the Orchestrator controller (RequireOrganizationUnit) unless folder_key is provided.	None
folder_key	str | None	Optional folder key, alternative to folder_path.	None
assignee	str | None	Optional username or email to assign the task to.	None
recipient	TaskRecipient | None	Optional structured recipient (user id / group id / email). Resolved via identity service before assignment.	None
priority	str | None	Optional priority. Low / Medium / High / Critical.	None
labels	list[str] | None	Optional list of labels for the task.	None
is_actionable_message_enabled	bool | None	Whether actionable notifications are enabled for this task.	None
actionable_message_metadata	dict[str, Any] | None	Optional metadata override. For QuickForm, when null, Orchestrator derives it from the referenced TaskSchema.	None
creator_job_key	str | None	Optional. Identifies the job that triggered the inline schema creation/upsert.	None
source_name	str	Source name on TaskSource. Defaults to 'Agent'.	'Agent'

Returns:

Name	Type	Description
Task	Task	The created task object.

retrieve

retrieve(
    action_key,
    app_folder_path=None,
    app_folder_key=None,
    app_name=None,
)

Retrieves a task by its key synchronously.

Parameters:

Name	Type	Description	Default
action_key	str	The unique identifier of the task to retrieve	required
app_folder_path	str | None	Optional folder path for the task	None
app_folder_key	str | None	Optional folder key for the task	None
app_name	str | None	app name hint for resource override	None

Returns: Task: The retrieved task object

retrieve_async async

retrieve_async(
    action_key,
    app_folder_path=None,
    app_folder_key=None,
    app_name=None,
)

Retrieves a task by its key asynchronously.

Parameters:

Name	Type	Description	Default
action_key	str	The unique identifier of the task to retrieve	required
app_folder_path	str | None	Optional folder path for the task	None
app_folder_key	str | None	Optional folder key for the task	None
app_name	str | None	app name hint for resource override	None

Returns: Task: The retrieved task object