Introduction to Automation Hub API

The Open API feature allows UiPath Automation Hub users to access and manipulate their tenant data programmatically. Based on the feedback received, as well as the platform structure, we've focused on delivering API requests as in below examples:

Note:

• The entire API calls list can be found in Swagger and Postman documentation.
• Some quick examples on how to use API calls can be found in Examples of API Calls. For an in-depth experience or to test specific API responses, use the Swagger or Postman environment described in API References.

Customized Assessments

• GET/idea-schema
• POST/idea-from-schema
• GET/automations/{automationId}/schema
• PATCH/automations/{automationId}

Automation Ideas

• GET/automations
• GET/automations/collaborators
• DELETE/automations/{automationId}/collaborators
• POST/automations/{automationId}/collaborators
• GET/automations/{automationId}/documents
• POST/automations/{automationId}/documents
• GET/automations/{automationId}/components
• GET/questionnaire
• GET/cba
• PUT/automations/cba/{automationId}/project-plan-baseline
• POST/automationidea
• POST/coe-automationidea
• POST/processmining-idea
• POST/automations/{automationId}/media
• POST/automations/status
• POST/automations/{automationId}/tags
• PUT/automation/{automationId}/categories

Automation Pipeline

• GET/automationpipeline

Users

• GET/users
• GET/roles
• POST/adduser
• POST/edituser

Application Inventory

• GET/appinventory
• PUT/appinventory
• DELETE/appinventory/{applicationId}

Categories

• GET/hierarchy
• PUT/categories

Components

• GET/components

Automation Store

• GET/automation-store
• GET/automation-store/{automationId}/reviews

The API calls reflects actions that a user can perform in the Automation Hub interface.

To start making calls with the following variables access the OpenAPI options from the Automation Hub platform > Admin Console > Platform Setup > Open API and generate your token.

Variable	Value
Token	The token generated from the Automation Hub UI.
URL	https://cloud.uipath.com/{orgName}/{tenantName}/automationhub_/api/v1/openapi
Delayed Release URL	https://cloud.uipath.com/{orgName}/{tenantName}/automationhub_/api/v1/openapi
GET all ideas API structure for Delayed Release Organizations	https://cloud.uipath.com/{orgName}/{tenantName}/automationhub_/api/v1/openapi
App key	The app key generated from the Automation Hub UI.

Note: {orgName} and {tenantName} are variables that refer to the name of your organization and the name of your tenant.

The next step is to Consume the available APIs.

API References

The Automation Hub API Swagger definition can be accessed directly by adding the Authentication details in the Authorization key in the request call named Header.

https://cloud.uipath.com/{orgName}/{tenantName}/automationhub_/api/v1/api-doc/

The guide herein is built to support the Swagger documentation, by providing relevant and easy to follow examples.

To use Swagger documentation in Delayed Release Organizations, use the following link:

https://cloud.uipath.com/{orgName}/{tenantName}/automationhub_/api/v1/api-doc/

If you prefer to work with Postman, create a Postman environment. Afterwards, check out our API collection made available in Postman. The collection can be imported by clicking the Run in Postman button.