UiPath Automation Hub API — Automations

naftiko: 1.0.0-alpha2
info:
  label: UiPath Automation Hub API — Automations
  description: 'UiPath Automation Hub API — Automations. 7 operations. Lead operation: UiPath List Automations. Self-contained
    Naftiko capability covering one Uipath business surface.'
  tags:
  - Uipath
  - Automations
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    UIPATH_API_KEY: UIPATH_API_KEY
capability:
  consumes:
  - type: http
    namespace: automation-hub-automations
    baseUri: https://cloud.uipath.com/{orgName}/{tenantName}/automationhub_/api/v1
    description: UiPath Automation Hub API — Automations business capability. Self-contained, no shared references.
    resources:
    - name: automations
      path: /automations
      operations:
      - name: listautomations
        method: GET
        description: UiPath List Automations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: phase
          in: query
          type: string
          description: Filter automations by pipeline phase (e.g., Idea, Assessment, Development, Testing, Production)
        - name: status
          in: query
          type: string
          description: Filter automations by status within their current phase
        - name: page
          in: query
          type: integer
          description: Page number for pagination (1-based)
        - name: pageSize
          in: query
          type: integer
          description: Number of records per page
      - name: createautomationidea
        method: POST
        description: UiPath Create an Automation Idea
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: automations-automationId
      path: /automations/{automationId}
      operations:
      - name: getautomation
        method: GET
        description: UiPath Get an Automation by ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateautomation
        method: PATCH
        description: UiPath Update an Automation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteautomation
        method: DELETE
        description: UiPath Delete an Automation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: automations-automationId-collaborators
      path: /automations/{automationId}/collaborators
      operations:
      - name: listautomationcollaborators
        method: GET
        description: UiPath List Collaborators for an Automation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: removeautomationcollaborator
        method: DELETE
        description: UiPath Remove a Collaborator from an Automation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: userId
          in: query
          type: integer
          description: Unique identifier of the user to remove as a collaborator
          required: true
    authentication:
      type: apikey
      key: Authorization
      value: '{{env.UIPATH_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: automation-hub-automations-rest
    port: 8080
    description: REST adapter for UiPath Automation Hub API — Automations. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/automations
      name: automations
      description: REST surface for automations.
      operations:
      - method: GET
        name: listautomations
        description: UiPath List Automations
        call: automation-hub-automations.listautomations
        with:
          phase: rest.phase
          status: rest.status
          page: rest.page
          pageSize: rest.pageSize
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createautomationidea
        description: UiPath Create an Automation Idea
        call: automation-hub-automations.createautomationidea
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/automations/{automationid}
      name: automations-automationid
      description: REST surface for automations-automationId.
      operations:
      - method: GET
        name: getautomation
        description: UiPath Get an Automation by ID
        call: automation-hub-automations.getautomation
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateautomation
        description: UiPath Update an Automation
        call: automation-hub-automations.updateautomation
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteautomation
        description: UiPath Delete an Automation
        call: automation-hub-automations.deleteautomation
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/automations/{automationid}/collaborators
      name: automations-automationid-collaborators
      description: REST surface for automations-automationId-collaborators.
      operations:
      - method: GET
        name: listautomationcollaborators
        description: UiPath List Collaborators for an Automation
        call: automation-hub-automations.listautomationcollaborators
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: removeautomationcollaborator
        description: UiPath Remove a Collaborator from an Automation
        call: automation-hub-automations.removeautomationcollaborator
        with:
          userId: rest.userId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: automation-hub-automations-mcp
    port: 9090
    transport: http
    description: MCP adapter for UiPath Automation Hub API — Automations. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: uipath-list-automations
      description: UiPath List Automations
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: automation-hub-automations.listautomations
      with:
        phase: tools.phase
        status: tools.status
        page: tools.page
        pageSize: tools.pageSize
      outputParameters:
      - type: object
        mapping: $.
    - name: uipath-create-automation-idea
      description: UiPath Create an Automation Idea
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: automation-hub-automations.createautomationidea
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: uipath-get-automation-id
      description: UiPath Get an Automation by ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: automation-hub-automations.getautomation
      outputParameters:
      - type: object
        mapping: $.
    - name: uipath-update-automation
      description: UiPath Update an Automation
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: automation-hub-automations.updateautomation
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: uipath-delete-automation
      description: UiPath Delete an Automation
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: automation-hub-automations.deleteautomation
      outputParameters:
      - type: object
        mapping: $.
    - name: uipath-list-collaborators-automation
      description: UiPath List Collaborators for an Automation
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: automation-hub-automations.listautomationcollaborators
      outputParameters:
      - type: object
        mapping: $.
    - name: uipath-remove-collaborator-automation
      description: UiPath Remove a Collaborator from an Automation
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: automation-hub-automations.removeautomationcollaborator
      with:
        userId: tools.userId
      outputParameters:
      - type: object
        mapping: $.