automation-anywhere Deployments API

openapi: 3.1.0
info:
  title: Automation Anywhere API Task Execution AccessDetails Deployments API
  description: The Automation Anywhere API Task Execution API enables developers to invoke API Tasks — a specialized type of cloud-based bot designed to be called synchronously from external applications like a REST service. The API provides endpoints to list API Task allocations, generate unique execution URLs and tokens, and execute API Tasks in real time. API Tasks execute on cloud infrastructure without requiring local Bot Runner devices, and are designed for low latency with near-real-time response rates. The execution URL and authorization token are short-lived and must be refreshed periodically to prevent authorization failures.
  version: '2019'
  contact:
    name: Automation Anywhere Support
    url: https://support.automationanywhere.com
  termsOfService: https://www.automationanywhere.com/terms-of-service
servers:
- url: https://{controlRoomUrl}/orchestrator/v1/hotbot
  description: Automation Anywhere API Task Orchestrator
  variables:
    controlRoomUrl:
      default: your-control-room.automationanywhere.com
      description: Your Control Room hostname
security:
- bearerAuth: []
- xAuthorization: []
tags:
- name: Deployments
  description: Deploy bots to Bot Runner devices and monitor deployment status
paths:
  /automations/deploy:
    post:
      operationId: deployBot
      summary: Deploy a bot
      description: Deploys an automation bot from the public workspace to one or more Bot Runner devices. Supports unattended deployment (to devices linked to a specified user), attended deployment (to any device accessible to the user), and headless deployment (to On-Demand Bot Runner devices). Returns a deploymentId that can be used to monitor the execution status. Input variables can be passed at runtime via the botInput field.
      tags:
      - Deployments
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeploymentRequest'
      responses:
        '200':
          description: Bot deployment initiated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentResponse'
        '400':
          description: Bad request — invalid parameters or bot not found in workspace
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Authentication required — missing or invalid JWT token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Bot or device not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    AttendedRequest:
      type: object
      description: Deployment configuration for attended bot execution. The bot runs on a device where the target user is currently logged in, with the user present to observe or interact.
      properties:
        currentUserDeviceId:
          type: integer
          description: Device ID of the currently logged-in user's machine on which to run the attended bot.
    UnattendedRequest:
      type: object
      description: Deployment configuration for unattended bot execution. The bot runs on the device(s) associated with the specified runAsUser account, without requiring a logged-in Windows session.
      properties:
        runAsUsers:
          type: array
          description: List of user IDs whose associated Bot Runner devices will execute the bot. Each user must have an unattended Bot Runner license.
          items:
            $ref: '#/components/schemas/RunAsUser'
        poolIds:
          type: array
          description: List of device pool IDs to target for execution. The bot will be dispatched to an available device in the specified pools.
          items:
            type: integer
            description: Numeric ID of a device pool
    DeploymentRequest:
      type: object
      description: 'Request payload to deploy a bot. Requires the botId and one of the deployment type objects: unattended, attended, or headless.'
      required:
      - botId
      properties:
        botId:
          type: integer
          description: Numeric file ID of the bot to deploy from the public workspace
        automationName:
          type: string
          description: Optional human-readable name for this automation deployment instance. Appears in activity logs and the Control Room dashboard.
        description:
          type: string
          description: Optional description of this deployment for tracking purposes
        botLabel:
          type: string
          description: Optional label to tag this bot deployment instance
        runElevated:
          type: boolean
          description: Whether to run the bot with elevated system privileges on the Bot Runner device. Requires appropriate device configuration.
        hideBotAgentUi:
          type: boolean
          description: Whether to hide the Bot Agent user interface on the runner device during execution. Applicable to attended deployments.
        callbackInfo:
          $ref: '#/components/schemas/CallbackInfo'
        automationPriority:
          type: string
          description: Priority level for this automation in the execution queue. Higher priority automations are dispatched before lower priority ones.
          enum:
          - PRIORITY_LOW
          - PRIORITY_MEDIUM
          - PRIORITY_HIGH
        botInput:
          type: object
          description: Map of input variable names to typed values to pass to the bot at runtime. Keys are variable names defined in the bot; values are objects with type and value fields.
          additionalProperties:
            $ref: '#/components/schemas/BotInputVariable'
        unattendedRequest:
          $ref: '#/components/schemas/UnattendedRequest'
        attendedRequest:
          $ref: '#/components/schemas/AttendedRequest'
        headlessRequest:
          $ref: '#/components/schemas/HeadlessRequest'
    DeploymentResponse:
      type: object
      description: Response returned when a bot deployment is successfully initiated
      properties:
        deploymentId:
          type: string
          format: uuid
          description: Unique UUID identifier for this deployment instance. Use this ID to query automation activity and monitor execution status via the Bot Execution Orchestrator API.
    CallbackInfo:
      type: object
      description: Optional callback configuration for receiving execution status notifications at a webhook endpoint when the deployment completes or fails.
      properties:
        url:
          type: string
          format: uri
          description: URL of the callback endpoint to notify upon completion
        headers:
          type: object
          description: Optional HTTP headers to include in the callback request
          additionalProperties:
            type: string
    BotInputVariable:
      type: object
      description: Typed input variable value to pass to a bot at deployment time
      properties:
        type:
          type: string
          description: Data type of the variable. Must match the variable type defined in the bot (e.g., STRING, NUMBER, BOOLEAN, LIST, DICTIONARY, DATETIME).
          enum:
          - STRING
          - NUMBER
          - BOOLEAN
          - LIST
          - DICTIONARY
          - DATETIME
          - CREDENTIAL
        string:
          type: string
          description: String value for STRING type variables
        number:
          type: string
          description: Numeric value as a string for NUMBER type variables
        boolean:
          type: boolean
          description: Boolean value for BOOLEAN type variables
        list:
          type: object
          description: List structure for LIST type variables
        dictionary:
          type: object
          description: Key-value map for DICTIONARY type variables
    HeadlessRequest:
      type: object
      description: Deployment configuration for headless bot execution on On-Demand Bot Runner cloud devices without a persistent session.
      properties:
        numOfRunAsUsersToUse:
          type: integer
          description: Number of On-Demand Bot Runner instances to allocate for parallel headless execution.
    Error:
      type: object
      description: Standard error response
      properties:
        code:
          type: string
          description: Error code identifying the type of failure
        message:
          type: string
          description: Human-readable description of the error
    ErrorMessage:
      type: object
      description: Detailed error response including additional context
      properties:
        message:
          type: string
          description: Human-readable description of the error
        errorCode:
          type: string
          description: Specific error code for programmatic handling
    RunAsUser:
      type: object
      description: Reference to a user account whose device will run the bot
      properties:
        id:
          type: integer
          description: Numeric user ID of the run-as user
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT token obtained from the Authentication API
    xAuthorization:
      type: apiKey
      in: header
      name: X-Authorization
      description: JWT token obtained from the Authentication API
externalDocs:
  description: Automation Anywhere API Task Documentation
  url: https://docs.automationanywhere.com/bundle/enterprise-v2019/page/api-task-real-time-endpoint.html