Run Robot

Audience: Low-code Engineers

Skill Prerequisites: Actions, Tokens, Connectors

Starts a UiPath process (a "job") on one or more UiPath robots, and saves UiPath's response in a token. Use it to hand off work to a robotic process automation (RPA) robot from a form, workflow or scheduled job.

note

This action is part of the UiPath add-on, which is installed and licensed separately (feature package UIPATH). If it isn't licensed, the action fails with a not-licensed error.

caution

The action signs in to https://platform.uipath.com with a username and password, using UiPath's older authentication API. UiPath has since moved Automation Cloud to OAuth-based external applications, so this sign-in may not work with current tenants. Test it with your UiPath account before relying on it.

Typical Use Cases

• Start a robot that enters submitted form data into a legacy desktop application
• Run an RPA process from a scheduled job, for example a nightly report
• Pass values from Plant an App to a robot as input arguments

Don't use it to

• Wait for the robot to finish or get its results. The action only starts the job.
• Call other UiPath APIs. Use Server Request.

Related Actions

Action Name	Description
Add UiPath Connector	Creates the UiPath connector used by this action.
Update UiPath Connector	Changes the connector's sign-in details.
Test Connector	Checks that the connector can sign in to UiPath.
Parse JSON Into Tokens	Reads values, such as the job ID, from the response.

Input Parameter Reference

Parameter	Description	Supports Tokens	Default	Required
Connector	The UiPath connector with the tenant name, username and password.	No	empty	Yes
Release Key	The key of the UiPath process release to run. You can get it from UiPath's Releases API.	Yes	empty string	Yes
Robot Ids list	The numeric IDs of the robots that should run the job, separated by commas, for example 12,15.	Yes	empty string	Yes
Input Arguments	The process's input arguments, as rows of argument name and value. Tokens are replaced in both columns. All values are sent as text.	Yes	empty	No

Output Parameters Reference

Parameter	Description
Output Token Name	The name of the token that receives UiPath's response to the StartJobs call, as JSON. [<Output Token Name>:Payload] holds the JSON the action sent.

How it works

1. The action signs in to UiPath with the connector's details. The sign-in is cached for 10 minutes per connector.
2. It asks UiPath to start the release on exactly the robots you listed.
3. It saves UiPath's response in the output token and continues with the next action.

Considerations

• Check the response. The action doesn't check whether UiPath accepted the job. An error from UiPath, such as an unknown release key, is saved in the output token like a normal response, and the next actions still run. Parse the response and check it with a condition.
• Robot IDs must be numbers. Anything else in Robot Ids list makes the action fail.
• A failed sign-in fails the action, with Authentication failed.
• The job runs in the background. The action returns as soon as UiPath has the request.
• Input argument values are text. If the process expects numbers or booleans, convert them in the UiPath process.

Examples

tip

To understand how to use the below examples, please see Running Examples.

1. Start a robot with form data

This action starts the release in [InvoiceReleaseKey] on robot 12, passing the invoice number and amount. Pick your UiPath connector in Connector after importing.

{
    "Title": "Run Robot",
    "ActionType": "UiPath.RunRobot",
    "Description": "Start the invoice entry robot",
    "Parameters": {
        "ReleaseKey": "[InvoiceReleaseKey]",
        "RobotIds": "12",
        "InputArguments": [
            {
                "name": "InvoiceNumber",
                "value": "[InvoiceNumber]"
            },
            {
                "name": "Amount",
                "value": "[Amount]"
            }
        ],
        "OutputToken": "RobotJob"
    }
}

Revised 09/28/2026