> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/uipath.md).

# UiPath

Connect to UiPath Orchestrator to start automations, follow their jobs and logs, and work with queues.

## Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| UiPath    | Credentials    |

### UiPath

Connect to UiPath Orchestrator to start automations, follow their jobs, and work with queues.

#### Set up in UiPath

1. Prepare the UiPath account or service that the workflow will access. Grant access to the required resources and operations.
2. **Personal Access Token:** A UiPath personal access token, created under Preferences > Personal Access Token. Give it the Orchestrator API Access scope and the permissions the actions need, such as Folders View, Processes View, Jobs Create and View, and Queues Edit.

#### Set up in StackAI

1. Open **Settings → Connections**, add a connection, and select **UiPath**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field         | Required                 | What to enter                                                                                                                                                                                                                                                                                                                                                               |
| --------------------- | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Organization          | Yes                      | The organization segment of your Orchestrator URL, for example 'acme' in <https://cloud.uipath.com/acme/DefaultTenant>. [Provider instructions](https://cloud.uipath.com).                                                                                                                                                                                                  |
| Tenant                | Yes                      | The tenant segment of your Orchestrator URL.                                                                                                                                                                                                                                                                                                                                |
| Personal Access Token | Yes                      | A UiPath personal access token, created under Preferences > Personal Access Token. Give it the Orchestrator API Access scope and the permissions the actions need, such as Folders View, Processes View, Jobs Create and View, and Queues Edit. [Provider instructions](https://docs.uipath.com/automation-cloud/automation-cloud/latest/api-guide/personal-access-tokens). |
| Automation Cloud URL  | Optional / as applicable | Change this only for a regional Automation Cloud, such as <https://govcloud.uipath.com>. A standalone Orchestrator addresses its OData endpoints differently and is not supported here.                                                                                                                                                                                     |

### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

## Use an action

1. Add the required **UiPath** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

## Actions

### List Folders

List the UiPath Orchestrator folders the connection can reach.

#### Inputs

| Field           | Type    | Required | Description                                                                     |
| --------------- | ------- | -------- | ------------------------------------------------------------------------------- |
| Maximum Folders | integer | No       | The maximum number of folders to return across pages. Minimum: 1. Default: 100. |
| Resume Offset   | integer | No       | Continue from an earlier List Folders result. Minimum: 0. Default: 0.           |

#### Outputs

| Field        | Type          | Description                                    |
| ------------ | ------------- | ---------------------------------------------- |
| Folders      | object\_array | The folders the connection's token can reach.  |
| Result Count | integer       | The number of folders returned.                |
| Next Offset  | integer       | A continuation value when more folders remain. |

### List Processes

List the automations published to a UiPath Orchestrator folder.

#### Inputs

| Field             | Type            | Required | Description                                                                                         |
| ----------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------- |
| Folder            | select (string) | Yes      | The Orchestrator folder that holds the process or queue. Options load from the selected connection. |
| Maximum Processes | integer         | No       | The maximum number of processes to return across pages. Minimum: 1. Default: 100.                   |
| Resume Offset     | integer         | No       | Continue from an earlier List Processes result. Minimum: 0. Default: 0.                             |

#### Outputs

| Field        | Type          | Description                                      |
| ------------ | ------------- | ------------------------------------------------ |
| Processes    | object\_array | The processes published to the selected folder.  |
| Result Count | integer       | The number of processes returned.                |
| Next Offset  | integer       | A continuation value when more processes remain. |

### Start Job

Run a UiPath automation and return the jobs Orchestrator queued.

#### Inputs

| Field           | Type            | Required | Description                                                                                         |
| --------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------- |
| Folder          | select (string) | Yes      | The Orchestrator folder that holds the process or queue. Options load from the selected connection. |
| Process         | select (string) | Yes      | The process to run, as published to the selected folder. Options load from the selected connection. |
| Input Arguments | object          | No       | Values for the process's input arguments.                                                           |
| Job Count       | integer         | No       | How many copies of the process to run. Minimum: 1. Maximum: 100. Default: 1.                        |

#### Outputs

| Field     | Type          | Description                                    |
| --------- | ------------- | ---------------------------------------------- |
| Jobs      | object\_array | The queued jobs, with the state they start in. |
| Job Count | integer       | The number of jobs queued.                     |

### Get Job

Check how a UiPath job is doing and what it returned.

#### Inputs

| Field  | Type            | Required | Description                                                                                         |
| ------ | --------------- | -------- | --------------------------------------------------------------------------------------------------- |
| Folder | select (string) | Yes      | The Orchestrator folder that holds the process or queue. Options load from the selected connection. |
| Job ID | integer         | Yes      | The numeric ID of the job to read. Minimum: 1.                                                      |

#### Outputs

| Field            | Type     | Description                                                |
| ---------------- | -------- | ---------------------------------------------------------- |
| Job ID           | integer  | The job's numeric ID.                                      |
| Job Key          | string   | The job's GUID.                                            |
| State            | string   | Where the job is in its lifecycle.                         |
| Process          | string   | The process the job runs.                                  |
| Info             | string   | Orchestrator's note about the job, such as why it faulted. |
| Started At       | datetime | When a robot picked the job up.                            |
| Ended At         | datetime | When the job finished.                                     |
| Output Arguments | object   | The values the process returned.                           |

### Get Job Logs

Read the log entries a UiPath job wrote while it ran.

#### Inputs

| Field               | Type            | Required | Description                                                                                         |
| ------------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------- |
| Folder              | select (string) | Yes      | The Orchestrator folder that holds the process or queue. Options load from the selected connection. |
| Job Key             | string          | Yes      | The GUID of the job whose logs to read.                                                             |
| Maximum Log Entries | integer         | No       | The maximum number of log entries to return across pages. Minimum: 1. Default: 100.                 |
| Resume Offset       | integer         | No       | Continue from an earlier Get Job Logs result. Minimum: 0. Default: 0.                               |

#### Outputs

| Field        | Type          | Description                                    |
| ------------ | ------------- | ---------------------------------------------- |
| Log Entries  | object\_array | The job's log entries, oldest first.           |
| Result Count | integer       | The number of log entries returned.            |
| Next Offset  | integer       | A continuation value when more entries remain. |

### Add Queue Item

Add a work item to a UiPath queue.

#### Inputs

| Field        | Type            | Required | Description                                                                                         |
| ------------ | --------------- | -------- | --------------------------------------------------------------------------------------------------- |
| Folder       | select (string) | Yes      | The Orchestrator folder that holds the process or queue. Options load from the selected connection. |
| Queue        | select (string) | Yes      | The queue's name, as it appears in the selected folder. Options load from the selected connection.  |
| Item Content | object          | Yes      | The data the robot will process.                                                                    |
| Reference    | string          | No       | Your own identifier for this item, used to find it later.                                           |
| Priority     | select (string) | No       | How soon a robot should pick the item up. Available values: Low, Normal, High. Default: Normal.     |

#### Outputs

| Field      | Type     | Description                         |
| ---------- | -------- | ----------------------------------- |
| Item ID    | integer  | The item's numeric ID.              |
| Item Key   | string   | The item's GUID.                    |
| Status     | string   | The state the item was created in.  |
| Reference  | string   | The reference stored with the item. |
| Created At | datetime | When the item entered the queue.    |

### List Queue Items

Read the items in a UiPath queue, optionally filtered by status.

#### Inputs

| Field         | Type            | Required | Description                                                                                                          |
| ------------- | --------------- | -------- | -------------------------------------------------------------------------------------------------------------------- |
| Folder        | select (string) | Yes      | The Orchestrator folder that holds the process or queue. Options load from the selected connection.                  |
| Queue         | select (string) | Yes      | The queue's name, as it appears in the selected folder. Options load from the selected connection.                   |
| Status        | select (string) | No       | Only return items in this state. Available values: New, InProgress, Failed, Successful, Abandoned, Retried, Deleted. |
| Maximum Items | integer         | No       | The maximum number of items to return across pages. Minimum: 1. Default: 100.                                        |
| Resume Offset | integer         | No       | Continue from an earlier List Queue Items result. Minimum: 0. Default: 0.                                            |

#### Outputs

| Field        | Type          | Description                                  |
| ------------ | ------------- | -------------------------------------------- |
| Queue Items  | object\_array | The queue's items, newest first.             |
| Result Count | integer       | The number of items returned.                |
| Next Offset  | integer       | A continuation value when more items remain. |

## Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/uipath.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
