UiPath Robot

Robot API

The Robot is able to tackle various automation needs. These capabilities are greatly increased when you make use of the Robot API, offering a tailored experience to create domain-specific interfaces.

The Robot API is only used to manage your own jobs, and not for other users. It is accessible only from the machine on which the Robot is installed. The API shares the same version as the Robot, with each update offering backwards compatibility.

You can make use of the followings .NET Robot Client calls:

Including the Client in Your Application:

var client = new RobotClient(); 

Getting the List of Available Processes:

var processes = await client.GetProcesses(); 
var myProcess = processes.Single(process => process.Name == "MyProcess"); 
var job = myProcess.ToJob(); 

Using the Process Key to Start a Job:

var job = new Job("812e908a-7609-4b81-86db-73e3c1438be4"); 

Starting a Process Execution:

{ 
await client.RunJob(job); 
} 
catch (Exception ex) 
{ 
Console.WriteLine(ex.ToString()); 
} 

Adding Input Arguments:

job.InputArguments = {["numbers"] = new int[] { 1, 2, 3 } }}; 
await client.RunJob(job); 

Exporting Output Arguments:

var jobOutput = await client.RunJob(job); 
Console.WriteLine(jobOutput.Arguments["sumOfNumbers"]); 

Stopping a Process:

await client.RunJob(job, cancellationToken);

Monitoring the Process Status:

job.StatusChanged += (sender, args) => Console.WriteLine($"{((Job)sender).ProcessKey}: {args.Status}"); 
await client.RunJob(job); 

Using the Events Scheduler:

new RobotClient(new RobotClientSettings { EventScheduler = TaskScheduler.Default }) 

Updated 29 days ago


Robot API


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.