Documentation Index
Fetch the complete documentation index at: https://ai-kb.automationanywhere.com/llms.txt
Use this file to discover all available pages before exploring further.
The Automation Anywhere Toolkit allows your workflows to interact with Automation Anywhere’s APA Control Room — deploying bots, monitoring their status, retrieving their output, listing available bots, and canceling active executions.
Authentication
All Automation Anywhere tools require a Control Room connection. Each tool includes a Connection selector. If no connection is configured, click Add Connection to create one.
When creating a connection, provide the following:
| Field | Required | Description |
|---|
| Connection Name | Yes | A label to identify this connection (e.g., control-room-connection). |
| Control Room URL | Yes | The URL of your Automation Anywhere Control Room (e.g., https://your-company.automationanywhere.digital). |
| Username | Yes | Your Automation Anywhere username. |
| Authentication Version | Yes | Select V2 Authentication to use an API Key, or V1 Authentication to use a Password. |
| Credential | Yes | Your API Key (for V2) or Password (for V1). Type @ to reference a vault secret. |
Deploy Bot
Deploys an Automation Anywhere bot from the connected Control Room.
| Field | Required | Description |
|---|
| Connection | Yes | Select a configured Control Room connection. |
| Bot Id | Yes | The ID of the bot to deploy. Type @ to select a variable. |
| Automation Name | No | Name of the automation. Default is null. |
| Automation Description | No | Description of the automation being deployed. Default is null. |
| Bot Input | No | Array of inputs for the bot. Click Add Item to add entries, or enable JSON Mode to paste data or use @ variables. Default is null. |
| Deployment Type | No | Type of deployment request. Options: Attended Request, Unattended Request, Headless Request. Default is Unattended Request. |
| Run As User Ids | No | Array of user IDs to run the bot as. The bot will be deployed on one of the devices from the list provided. Type @ in any item to reference a variable. Default is null. |
| Pool Ids | No | Array of pool IDs specifying the number of run-as-users to use. Type @ in any item to reference a variable. Default is null. |
| Num Of Run As Users | No | How many run-as users should be used from the Run As User Ids list. If not specified, the deployment will happen on all devices available under the list. Default is 0. |
| Launch In Child Window | No | Specifies how deployment devices are selected. Options: RUN_ONLY_ON_DEFAULT_DEVICE — only the default device is used; PREFER_DEFAULT_DEVICE — prefers the default device, and if unavailable, uses another device from the pool; RUN_ON_POOL_DEVICES — the bot will be deployed on any available device from the pool. Default is RUN_ONLY_ON_DEFAULT_DEVICE. |
| Continue On Failure | No | If true, skips this step and continues the workflow normally if it fails. Default is false. |
| Retry On Failure | No | If true, automatically retries up to four attempts when the step fails. Default is false. |
Get Bot Status
Retrieves the current execution status of a deployed bot.
| Field | Required | Description |
|---|
| Connection | Yes | Select a configured Control Room connection. |
| Deployment Id | Yes | The deployment ID to check status for. Type @ to select a variable. |
| Poll Until Done | No | When enabled, keeps checking the bot status until it completes or fails, instead of returning immediately. |
Get Bot Output
Retrieves the output returned by a completed bot deployment.
| Field | Required | Description |
|---|
| Connection | Yes | Select a configured Control Room connection. |
| Deployment Id | Yes | The deployment ID to get output for. Type @ to select a variable. |
List Bots
Retrieves a list of bots available in the connected Control Room.
| Field | Required | Description |
|---|
| Connection | Yes | Select a configured Control Room connection. |
| Filter Name | No | Filter bots by name. Default is null. |
| Limit | No | Maximum number of bots to return. Default is 50. |
Cancel Bot Execution
Cancels an active bot deployment in the connected Control Room.
| Field | Required | Description |
|---|
| Connection | Yes | Select a configured Control Room connection. |
| Deployment Id | Yes | The deployment ID of the bot execution to cancel. Type @ to select a variable. |
