API Task

API Task is an API-based cloud automation solution that harnesses the power of APIs to facilitate seamless data exchange between disparate systems and applications at an unprecedented speed.

Key benefits of API Tasks:
  • Cloud-only: Leverage the scalability, security, and reliability of Automation Anywhere's managed Cloud infrastructure, without the need for on-premise hardware or maintenance. (Available only for Cloud, not On-Premises.)
  • Managed by Automation Anywhere: Our team takes care of the entire Cloud operation, ensuring smooth performance and seamless updates.
  • Flexible integration: Trigger API Tasks from various sources, including forms, processes, or direct endpoints. Schedule them for regular execution or run them on demand.

API Task's real-time data exchange capabilities enable it to adapt to dynamic environments and respond promptly. Use API Tasks to create automations using packages that are supported on Automation 360 Cloud. For instance, API Tasks work with our packages that do not intervene with the file system such as Salesforce, ServiceNow, Workday, REST, and SOAP to automate workflows and processes. You cannot use an API Task to automate a desktop operation.

Note:
  • Available with AWS and GCP Cloud.
  • API Tasks, unlike Task Bots, benefit from running entirely in the Cloud, managed by Automation Anywhere, eliminating the need for local Bot Runner devices.
  • Every cloud customer receives 100 API Task executions per Control Room as their free base entitlement. The base entitlement also includes two concurrent executions, meaning you can run two API Tasks simultaneously. For higher execution limits and additional concurrencies, you need to purchase the Enterprise Platform SKU or an API Task Overage SKU. Contact your customer service manager for more details.
  • The API Task requires cloud-based licensing for functionality. File-based licensing is not currently supported.
Different ways of invoking API Tasks:
  1. Invoke API Tasks in form
  2. Invoke API Tasks in process
  3. Run API Tasks (using Run now)
  4. Schedule API Tasks
  5. Invoke API Tasks as endpoints

Invoke API Tasks in form

Invoking an API Task in a form provides you with an immediate response after the initial run, ensuring that your processes receive immediate attention. During the initial run, the API Task or API Tasks within the Process are deployed in the cloud, enabling subsequent requests to be processed without any delay. To ensure optimal performance and scalability, API Tasks are intelligently pre-warmed on a dynamic number of cloud devices, to adapt to your concurrency needs. The diagram below describes the workflow to follow while invoking an API Task within a form.
Note: Pre-warming is a process in which the admin or a team manager adds the API Tasks to the cloud and the API Tasks are pre-deployed in cloud devices. The cloud devices are managed on the Automation Anywhere infrastructure.
API Task in a form
Real-Time Response: Empowering users with instantaneous results
  • Ideal for Forms: When users expect immediate response.
  • Key Features:
    • Pre-configured cloud device allocations for seamless execution.
    • Strict concurrency limits for optimal performance.
    • 1-minute execution cap for rapid completion.
Item Description
1 Create an API Task
2 Configure an API Task in a form
3 Configure a form with API Task in a process
4 Check in API Tasks to Repository
5 Add API Task to Cloud
6 Test Process (API Task in form)
7 Invoke the API Task through an Automation Co-Pilot, see Automation Co-Pilot for Business Users

Invoke API Tasks in process

Invoking an API Task in a process provides the flexibility to execute API Tasks in the background, allowing your processes to continue without interruption. This approach is particularly useful for tasks that can take longer to complete, as it ensures that your overall workflow remains efficient. The diagram below describes the workflow to follow to build a process that invokes an API Task.
Note: To enable on-demand API Task deployment within a process, generate a Registration Key in Administration > Settings > Bot agent bulk install > Generate a new key and click Save Changes.
API Task in a process

On-Demand Execution: Effortless automation within processes

  • Ideal for Processes: When tasks can run asynchronously, aligning with longer workflows.
  • Key Features:
    • Intelligent queuing for excess requests, ensuring execution as devices become available.
    • Concurrency limits for resource optimization.
    • Extended 15-minute execution window for more complex tasks.
Item Description
1 Create an API Task (API Task in Process)
2 Configure API Task in process
3 Test Process (API Task in process)
4 Check in API Tasks to Repository
5 Invoke the API Task through an Automation Co-Pilot, see Automation Co-Pilot for Business Users

Run API Tasks (using Run now)

Quickly execute API Tasks on demand by using the Run now button. This feature is accessible to both admins and developers within the public workspace. To learn more about using the Run now function, see Run API Tasks.

Schedule API Tasks

Automate the execution of API Tasks by scheduling them to run at specific times. Once scheduled, you can easily manage these tasks through various actions like activation, deactivation, and editing. For detailed instructions on scheduling API Tasks, see How to schedule API Tasks.

Invoke API Tasks as endpoints

Leverage your API Tasks as endpoints by invoking them programmatically from external applications. Whether you are using Postman for rapid prototyping, cURL for scripting, or building a full-fledged web application, you can effortlessly initiate API Tasks. For more information on invoking API Tasks as using a real-time endpoint or as an on-demand endpoint, see API Task real-time endpoint and API Task on-demand endpoint.

Deploying API Tasks

Unlike Attended or Unattended deployments, API Tasks leverage cloud-based bots (API Tasks) for deployment, eliminating the need for physical devices. This headless approach offers scalability and flexibility, enabling you to automate your processes from anywhere, at any time. The below table shows and compares the various deployments.

Attended Deployment Unattended Deployment Headless Deployment (API Task)
Requires a physical device to execute tasks, suitable for tasks that require human interaction. Requires a physical device to execute tasks, suitable for tasks that can be completed independently. Cloud-based deployment eliminates the need for physical devices, offering scalability and flexibility.