UiPath website screenshot

UiPath

UiPath is an enterprise automation platform offering robotic process automation (RPA), AI-powered automation, and agentic automation capabilities. The platform includes Orchestrator for managing robots and automation jobs, Studio for developing automation workflows, Document Understanding for intelligent document processing, Data Service for structured data storage, Automation Hub for pipeline management and governance, Test Manager for automated testing, and Platform Management for organization and tenant administration. UiPath provides Python SDKs, REST APIs, and a rich integration ecosystem supporting enterprise automation at scale.

6 APIs 8 Features
AutomationRobotic Process AutomationRPAArtificial IntelligenceDocument ProcessingEnterprise AutomationOrchestrationTesting

APIs

UiPath Orchestrator API

The UiPath Orchestrator API provides programmatic access to the core automation management platform, enabling developers to manage robots, jobs, processes, queues, assets, sched...

UiPath Automation Hub API

The UiPath Automation Hub API provides access to the automation pipeline and idea management platform, allowing developers to programmatically create, retrieve, and manage autom...

UiPath Document Understanding API

The UiPath Document Understanding API enables intelligent document processing using machine learning and AI models. Developers can submit documents for digitization, classificat...

UiPath Data Service API

The UiPath Data Service API provides programmatic access to structured data storage within the UiPath Platform. Developers can create, read, update, and delete records in custom...

UiPath Platform Management API

The UiPath Platform Management API provides administrative access to organization and tenant management capabilities, including user management, license management, and account ...

UiPath Test Manager API

The UiPath Test Manager API enables programmatic interaction with the automated testing platform, allowing CI/CD pipelines and external tools to create test sets, execute tests,...

Agent Skills

uipath-admin

AGENT SKILL

uipath-agents

AGENT SKILL

uipath-api-workflow

AGENT SKILL

uipath-coded-apps

AGENT SKILL

uipath-data-fabric

AGENT SKILL

uipath-feedback

AGENT SKILL

uipath-governance

AGENT SKILL

uipath-ixp

AGENT SKILL

uipath-maestro-bpmn

AGENT SKILL

uipath-maestro-case

AGENT SKILL

uipath-maestro-flow

AGENT SKILL

uipath-planner

AGENT SKILL

uipath-platform

AGENT SKILL

uipath-review

AGENT SKILL

uipath-rpa

AGENT SKILL

uipath-solution

AGENT SKILL

uipath-tasks

AGENT SKILL

uipath-test

AGENT SKILL

uipath-troubleshoot

AGENT SKILL

Collections

Arazzo Workflows

UiPath Add and Track a Queue Item

Resolve an existing queue, add a transaction item, and read back its status.

ARAZZO

UiPath Asset Lifecycle

Create, read, update, and delete a shared asset end to end.

ARAZZO

UiPath Bootstrap a Test Project

Create a test project, seed a test case and a test set, then read back the project.

ARAZZO

UiPath Find and Remove a Webhook

Locate a webhook by its target URL and delete the subscription.

ARAZZO

UiPath Digitize, Classify, and Extract a Document

Run the full document understanding pipeline with polling for async results.

ARAZZO

UiPath Discover Extractors and Extract a Document

Resolve a project, discover its extractors, digitize a document, and extract data with polling.

ARAZZO

UiPath Data Service Entity Record Lifecycle

Create, read, update, and delete a custom entity record end to end.

ARAZZO

UiPath Fleet Readiness Audit

Resolve a folder, then inventory its machines, robots, and recent jobs.

ARAZZO

UiPath Provision a Credential Asset

Create a credential asset and confirm it by reading it back.

ARAZZO

UiPath Provision a Queue and Add an Item

Create a transaction queue and seed it with its first work item.

ARAZZO

UiPath Register a Job Event Webhook

Discover available event types, create a webhook, and confirm its registration.

ARAZZO

UiPath Establish Requirement Traceability

Resolve a test project, create a requirement and a covering test case, then list test cases.

ARAZZO

UiPath Resolve Folder and Start a Job

Resolve a folder context, pick a deployed process, and start a job in it.

ARAZZO

UiPath Rotate an Asset Value

Read an existing asset, write an updated value, and verify the change.

ARAZZO

UiPath Start and Monitor a Job

Start a job for a process and poll its state until it reaches a terminal outcome.

ARAZZO

UiPath Find and Stop a Running Job

Locate a currently running job and send it a stop signal.

ARAZZO

UiPath Trigger a Scheduled Process On Demand

Find a configured schedule, resolve its process, and run it immediately.

ARAZZO

UiPath Upsert a Data Service Entity Record

Query an entity by a key field and update the match or create a new record.

ARAZZO

Pricing Plans

Uipath Plans Pricing

5 plans

PLANS

Rate Limits

Uipath Rate Limits

5 limits

RATE LIMITS

FinOps

Uipath Finops

FINOPS

Features

Robotic Process Automation

Automate repetitive tasks across any application using software robots with no-code, low-code, and coded automation options.

AI-Powered Automation

Integrate AI capabilities including document understanding, computer vision, and natural language processing into automation workflows.

Agentic Automation

Build and deploy intelligent agents using Python, LangGraph, or LlamaIndex frameworks on the UiPath Agent Cloud.

Document Understanding

Extract structured data from unstructured documents using ML models for OCR, classification, and field extraction.

Orchestration

Centrally manage and monitor automation robots, jobs, queues, schedules, and assets across the enterprise.

Process Mining

Discover and analyze business processes to identify automation opportunities and measure impact.

Test Automation

Create, manage, and execute automated tests for RPA and application testing with enterprise CI/CD integration.

Integration Service

Connect to 1,000+ applications and services through pre-built connectors for enterprise integration.

Use Cases

Finance and Accounting Automation

Automate invoice processing, accounts payable/receivable, financial reporting, and compliance workflows.

HR Onboarding Automation

Streamline employee onboarding, offboarding, payroll processing, and HR data management across systems.

Customer Service Automation

Automate customer inquiry routing, case management, data lookup, and response generation.

IT Process Automation

Automate IT service desk tickets, provisioning, monitoring alerts, and infrastructure management tasks.

Healthcare Administration

Automate patient data management, claims processing, prior authorization, and regulatory reporting.

Supply Chain Automation

Automate procurement, order management, inventory tracking, and logistics workflows.

Integrations

Salesforce

Automate CRM operations, data sync, and customer workflows with native Salesforce integration.

SAP

Connect with SAP ERP and S/4HANA for automated finance, HR, and supply chain processes.

Microsoft 365

Automate Office applications, SharePoint, Teams, and Azure services through Microsoft 365 integration.

ServiceNow

Integrate with ServiceNow for ITSM automation, ticket management, and service catalog workflows.

Workday

Connect with Workday HCM for HR automation, payroll processing, and workforce management.

LangChain and LangGraph

Build and deploy AI agents using LangChain and LangGraph frameworks on the UiPath platform.

Solutions

Automation Cloud Basic

Entry-level cloud automation for individuals and small teams with basic RPA and limited scale.

Automation Cloud Standard

Professional automation platform for businesses with unlimited users, robots, and enterprise data extraction.

Automation Cloud Enterprise

Strategic enterprise automation with full infrastructure control, BYOK, multi-region deployment, and advanced AI capabilities.

Automation Cloud Public Sector

FedRAMP Moderate authorized automation solution for U.S. government and public sector organizations.

Event Specifications

UiPath Orchestrator Webhook Events

The UiPath Orchestrator webhook system delivers real-time event notifications to registered HTTP endpoints when automation events occur within the platform. Webhooks cover event...

ASYNCAPI

Semantic Vocabularies

Uipath Automation Hub Context

18 classes · 24 properties

JSON-LD

Uipath Context

0 classes · 15 properties

JSON-LD

Uipath Data Service Context

7 classes · 19 properties

JSON-LD

Uipath Document Understanding Context

19 classes · 35 properties

JSON-LD

Uipath General Context

2 classes · 3 properties

JSON-LD

Uipath Orchestrator Context

27 classes · 77 properties

JSON-LD

Uipath Platform Management Context

14 classes · 29 properties

JSON-LD

Uipath Test Manager Context

16 classes · 26 properties

JSON-LD

API Governance Rules

UiPath API Rules

40 rules · 15 errors 20 warnings 5 info

SPECTRAL

JSON Structure

Automation Hub Add User Request Structure

2 properties

JSON STRUCTURE

Automation Hub Application Structure

5 properties

JSON STRUCTURE

Automation Hub Automation Structure

10 properties

JSON STRUCTURE

Automation Hub Benefit Data Structure

3 properties

JSON STRUCTURE

Automation Hub Collaborator Structure

4 properties

JSON STRUCTURE

Automation Hub Edit User Request Structure

3 properties

JSON STRUCTURE

Automation Hub Phase Count Structure

2 properties

JSON STRUCTURE

Automation Hub Pipeline Data Structure

1 properties

JSON STRUCTURE

Automation Hub Role Structure

3 properties

JSON STRUCTURE

Automation Hub User List Response Structure

2 properties

JSON STRUCTURE

Automation Hub User Structure

5 properties

JSON STRUCTURE

Data Service Entity Query Request Structure

5 properties

JSON STRUCTURE

Data Service Entity Record Input Structure

0 properties

JSON STRUCTURE

Data Service Entity Record Structure

5 properties

JSON STRUCTURE

Data Service Filter Group Structure

3 properties

JSON STRUCTURE

Data Service Order By Clause Structure

2 properties

JSON STRUCTURE

Data Service Query Filter Structure

3 properties

JSON STRUCTURE

Document Understanding Classifier Structure

4 properties

JSON STRUCTURE

Document Understanding Extractor Structure

4 properties

JSON STRUCTURE

Document Understanding Field Value Structure

4 properties

JSON STRUCTURE

Document Understanding Project Structure

5 properties

JSON STRUCTURE

Orchestrator Add Queue Item Request Structure

1 properties

JSON STRUCTURE

Orchestrator Asset Structure

10 properties

JSON STRUCTURE

Orchestrator Job Structure

15 properties

JSON STRUCTURE

Orchestrator O Data Job Collection Structure

3 properties

JSON STRUCTURE

Orchestrator O Data Role Collection Structure

1 properties

JSON STRUCTURE

Orchestrator O Data User Collection Structure

1 properties

JSON STRUCTURE

Orchestrator Queue Definition Structure

7 properties

JSON STRUCTURE

Orchestrator Queue Item Data Structure

6 properties

JSON STRUCTURE

Orchestrator Queue Item Structure

14 properties

JSON STRUCTURE

Orchestrator Robot Ref Structure

6 properties

JSON STRUCTURE

Orchestrator Start Info Structure

7 properties

JSON STRUCTURE

Orchestrator Start Jobs Request Structure

1 properties

JSON STRUCTURE

Orchestrator Stop Job Request Structure

2 properties

JSON STRUCTURE

Orchestrator Webhook Event Type Structure

2 properties

JSON STRUCTURE

Orchestrator Webhook Structure

7 properties

JSON STRUCTURE

Platform Management Audit Event Structure

12 properties

JSON STRUCTURE

Platform Management Audit Source Structure

2 properties

JSON STRUCTURE

Platform Management Audit Sources Structure

1 properties

JSON STRUCTURE

Platform Management Client Info Structure

2 properties

JSON STRUCTURE

Platform Management Group Structure

4 properties

JSON STRUCTURE

Platform Management User Structure

6 properties

JSON STRUCTURE

Test Manager Create Project Request Structure

2 properties

JSON STRUCTURE

Test Manager Project List Response Structure

4 properties

JSON STRUCTURE

Test Manager Project Structure

7 properties

JSON STRUCTURE

Test Manager Requirement Structure

7 properties

JSON STRUCTURE

Test Manager Test Case Structure

7 properties

JSON STRUCTURE

Test Manager Test Execution Structure

10 properties

JSON STRUCTURE

Test Manager Test Set List Response Structure

2 properties

JSON STRUCTURE

Test Manager Test Set Structure

5 properties

JSON STRUCTURE

Uipath Document Understanding Structure

0 properties

JSON STRUCTURE

Uipath Orchestrator Structure

3 properties

JSON STRUCTURE

Example Payloads

Automation Hub Role Example

3 fields

EXAMPLE

Automation Hub User Example

5 fields

EXAMPLE

Orchestrator Asset Example

10 fields

EXAMPLE

Orchestrator Job Example

15 fields

EXAMPLE

Orchestrator Webhook Example

7 fields

EXAMPLE

Test Manager Project Example

7 fields

EXAMPLE

Uipath Orchestrator Example

3 fields

EXAMPLE

Resources

🔗
PostmanWorkspace
PostmanWorkspace
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
LinkedIn
LinkedIn
🔗
Website
Website
🔗
Documentation
Documentation
🌐
Portal
Portal
📰
Blog
Blog
💰
Pricing
Pricing
📜
TermsOfService
TermsOfService
📜
PrivacyPolicy
PrivacyPolicy
💬
Support
Support
🟢
StatusPage
StatusPage
🎓
Academy
Academy
🔗
Forums
Forums
👥
GitHubOrganization
GitHubOrganization
📦
Python SDK
SDKs
📦
Python SDK GitHub
SDKs
📦
LangChain Python SDK
SDKs
📦
TypeScript SDK
SDKs
📦
Python Integrations SDK
SDKs
🔧
MCP Server
Tools
🔗
UiPath CLI
CLI
🔗
CLI
CLI
📝
Signup
Signup
🚀
GettingStarted
GettingStarted
🔑
Authentication
Authentication
🔗
SpectralRules
SpectralRules
🔗
Vocabulary
Vocabulary
🔗
MCPServer
MCPServer
🔗
AgentSkills
AgentSkills
🔗
LlmsText
LlmsText

Sources

Raw ↑
opencollection: 1.0.0
info:
  name: UiPath Test Manager API
  version: '2'
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Projects
    type: folder
  items:
  - info:
      name: UiPath List Test Projects
      type: http
    http:
      method: GET
      url: https://cloud.uipath.com/{organizationName}/{tenantName}/testmanager_/api/v2/projects
      params:
      - name: page
        value: '1'
        type: query
        description: Page number for pagination (0-based)
      - name: pageSize
        value: '1'
        type: query
        description: Number of records per page
    docs: Retrieves all test projects accessible to the authenticated user. Projects are the top-level containers for test
      cases, requirements, test sets, and execution results. Requires the TM.Projects or TM.Projects.Read OAuth scope.
  - info:
      name: UiPath Create a Test Project
      type: http
    http:
      method: POST
      url: https://cloud.uipath.com/{organizationName}/{tenantName}/testmanager_/api/v2/projects
      body:
        type: json
        data: '{}'
    docs: Creates a new test project in Test Manager. The project becomes the container for all test cases, requirements,
      and test sets associated with the testing effort. Requires the TM.Projects OAuth scope.
  - info:
      name: UiPath Get a Test Project by ID
      type: http
    http:
      method: GET
      url: https://cloud.uipath.com/{organizationName}/{tenantName}/testmanager_/api/v2/projects/:projectId
      params:
      - name: projectId
        value: ''
        type: path
        description: Unique identifier of the test project
    docs: Retrieves a specific test project by its unique identifier. Returns project details including name, description,
      creation date, and summary statistics for test cases and requirements.
- info:
    name: TestCases
    type: folder
  items:
  - info:
      name: UiPath List Test Cases in a Project
      type: http
    http:
      method: GET
      url: https://cloud.uipath.com/{organizationName}/{tenantName}/testmanager_/api/v2/projects/:projectId/testcases
      params:
      - name: projectId
        value: ''
        type: path
        description: Unique identifier of the test project
      - name: page
        value: '1'
        type: query
        description: Page number for pagination (0-based)
      - name: pageSize
        value: '1'
        type: query
        description: Number of records per page
    docs: Retrieves all test cases defined within a specific test project. Each test case represents a single test scenario
      with preconditions, steps, and expected results. Supports pagination and filtering. Requires the TM.TestCases or TM.TestCases.Read
      OAuth scope.
  - info:
      name: UiPath Create a Test Case
      type: http
    http:
      method: POST
      url: https://cloud.uipath.com/{organizationName}/{tenantName}/testmanager_/api/v2/projects/:projectId/testcases
      params:
      - name: projectId
        value: ''
        type: path
        description: Unique identifier of the test project
      body:
        type: json
        data: '{}'
    docs: Creates a new test case within a test project. The test case can be linked to automation packages deployed in Orchestrator
      to enable automated test execution via test sets. Requires the TM.TestCases OAuth scope.
  - info:
      name: UiPath Get a Test Case by ID
      type: http
    http:
      method: GET
      url: https://cloud.uipath.com/{organizationName}/{tenantName}/testmanager_/api/v2/projects/:projectId/testcases/:testCaseId
      params:
      - name: projectId
        value: ''
        type: path
        description: Unique identifier of the test project
      - name: testCaseId
        value: ''
        type: path
        description: Unique identifier of the test case
    docs: Retrieves a specific test case by its unique identifier within a project. Returns full test case details including
      steps, labels, custom fields, automation linkage, and preconditions.
- info:
    name: TestSets
    type: folder
  items:
  - info:
      name: UiPath List Test Sets in a Project
      type: http
    http:
      method: GET
      url: https://cloud.uipath.com/{organizationName}/{tenantName}/testmanager_/api/v2/projects/:projectId/testsets
      params:
      - name: projectId
        value: ''
        type: path
        description: Unique identifier of the test project
      - name: page
        value: '1'
        type: query
        description: Page number for pagination (0-based)
      - name: pageSize
        value: '1'
        type: query
        description: Number of records per page
    docs: Retrieves all test sets within a specific test project. Test sets group test cases for coordinated execution runs
      and can be linked to Orchestrator processes to trigger automated execution.
  - info:
      name: UiPath Create a Test Set
      type: http
    http:
      method: POST
      url: https://cloud.uipath.com/{organizationName}/{tenantName}/testmanager_/api/v2/projects/:projectId/testsets
      params:
      - name: projectId
        value: ''
        type: path
        description: Unique identifier of the test project
      body:
        type: json
        data: '{}'
    docs: Creates a new test set within a project. The test set can include test cases and be configured to execute against
      specific Orchestrator environments. Requires the TM.TestSets OAuth scope.
- info:
    name: Requirements
    type: folder
  items:
  - info:
      name: UiPath List Requirements in a Project
      type: http
    http:
      method: GET
      url: https://cloud.uipath.com/{organizationName}/{tenantName}/testmanager_/api/v2/projects/:projectId/requirements
      params:
      - name: projectId
        value: ''
        type: path
        description: Unique identifier of the test project
      - name: page
        value: '1'
        type: query
        description: Page number for pagination (0-based)
      - name: pageSize
        value: '1'
        type: query
        description: Number of records per page
    docs: Retrieves all requirements defined within a specific test project. Requirements represent business or technical
      specifications that test cases are mapped to for traceability. Supports pagination. Requires the TM.Requirements or
      TM.Requirements.Read OAuth scope.
  - info:
      name: UiPath Create a Requirement
      type: http
    http:
      method: POST
      url: https://cloud.uipath.com/{organizationName}/{tenantName}/testmanager_/api/v2/projects/:projectId/requirements
      params:
      - name: projectId
        value: ''
        type: path
        description: Unique identifier of the test project
      body:
        type: json
        data: '{}'
    docs: Creates a new requirement within a test project. Requirements can be linked to test cases to establish traceability
      coverage. Requires the TM.Requirements OAuth scope.
- info:
    name: TestExecutions
    type: folder
  items:
  - info:
      name: UiPath List Test Executions in a Project
      type: http
    http:
      method: GET
      url: https://cloud.uipath.com/{organizationName}/{tenantName}/testmanager_/api/v2/projects/:projectId/testexecutions
      params:
      - name: projectId
        value: ''
        type: path
        description: Unique identifier of the test project
      - name: page
        value: '1'
        type: query
        description: Page number for pagination (0-based)
      - name: pageSize
        value: '1'
        type: query
        description: Number of records per page
    docs: Retrieves test execution results within a specific test project. Test executions represent runs of test sets and
      contain the aggregate pass/fail status across all included test cases. References to individual test case log objects
      are included for drill-down.
bundled: true