IQ Bot API Operations

IQ Bot API actions help upload and download documents to IQ Bot and track their status using the file ID, which eliminates the need to download and read CSV files

Top Benefits

  • V20 APIs reduce conflicts due to files uploaded to an instance with the same name, since the unique file ID is tracked
  • Documents in the validator can be re-run when cleared by saving the file IDs
  • These actions can be used to upload or download documents from one control room to another


  • The file is uploaded to the instance and the file ID is returned
  • The file ID is used to track file status
  • If the status is Success, document contents are returned to a data table
  • If the status is Validator, Untrained, or Unclassified, the bot moves to conditional statements where the handling logic can be written

This package has 3 custom actions:

  1. The 'IQ Bot Upload' action takes the control room URL, Learning instance ID, File Path, and Authentication Token. It returns the file ID of the uploaded file.
  2. The 'Check File Status' action takes Control Room URL, Learning instance ID, File ID, and Authentication Token. It returns one of 5 statuses:
  • Success
  • Validator
  • Untrained
  • Unclassified
  • Unknown
  1. The 'Get Document Details' action takes Control Room URL, File ID, and Authentication Token. It returns a table variable containing the document details (instead of downloading CSV files).

These custom actions help upload/track/download the documents to IQBot by tracking the file ID instead of the file name, which will reduce conflicts due to files with the same name being uploaded to the same instance and will also reduce the need for input file naming conventions.

The files will be classified into Success/Validator/Untrained/Unclassified instead of Success/Failure provided by the conventional actions.

The 'Download' action returns the document contents in a data table, which will reduce the need to download/save/maintain CSV files

These actions help download only the file uploaded using the file ID instead of downloading all of the files into the ‘Success’ folder.

  • These actions can be configured for any control room whose credentials can be put in the vault (not only in the control room in which the package is uploaded)
  • Instance ID can be variabilized
  • The 'Upload' action returns the file ID, which can be used to track file status/get document details.
  • The 'Check File Status' action helps track the status of the file using the file ID and returns either Success, Validator, Untrained, Unclassified or Unknown
  • The ‘Get Document Details’ action returns the data table containing the document details. The data table contains all of the form field and table fields extracted by IQ Bot (multi-rows are supported)
  • The column headers of the data table are the same as the IQ Bot field names
Get Package


Bot Security Program
Level 1
Business Process
Automation Type
Last Updated
June 7, 2021
First Published
June 4, 2021
Automation 360

See the Package in Action

IQ Bot 'Upload' and 'Check File Status' actions
Get Document details and total package
Upload framework
IQ Bot 'Upload' and 'Check File Status' actions
Get Document details and total package
Upload framework

Setup Process


Download the Package and follow the instructions to install it in your AAE Control Room.


Use the Package in a bot, configure keys and other credentials the package will need (see the ReadMe for details.)


That's it - now the Package is ready to get going!

Requirements and Inputs

  • Files should be uploaded in IQ Bot supported formats: PDF, JPG, PNG & TIFF
  • Control room credentials should be present in variable/credential vault
  • The credentials used should have 'IQ Bot Services' permission
  • Automation 360 in the control room used should be of version 20 or greater