Generate Task Execution URL/Token

This API endpoint generates task execution URL and Token with which you will be able to deploy an API Task.

POST https://{{ControlRoomURL}}/orchestrator/v1/hotbot/config/accessdetails
Request body:
{
  "botRepositoryPath": [
    "Automation Anywhere\\Bots\\Zip Code API Task"
  ]
}
Request parameters
Parameter Type Required Description
botRepositoryPath String Yes Repository path of the API Task.
Response:
{
  "accessDetails": {
    "Automation Anywhere\\Bots\\Zip Code API Task": {
      "url": "https://hotbot-2689-knative-0a665343-88e9-17be-8189-936dad5d0144.prod-ause1-ee.my.automationanywhere.digital/execute",
      "headers": {
        "X-Authorization": "eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiIzODAiLCJ0ZW5hbnRVdWlkIjoiMGE2NjUzNDMtODhlOS0xN2JlLTgxODktOTM2ZGFkNWQwMTQ0IiwiY2xpZW50VHlwZSI6IldFQiIsIm11bHRpcGxlTG9naW4iOnRydWUsImJvdElkIjoyNjg5LCJpYXQiOjE3MDgzNTIxOTgsImV4cCI6MTcwODM5NTM5OCwiaXNzIjoiQXV0b21hdGlvbkFueXdoZXJlIiwibmFub1RpbWUiOjI5OTg3MDkyNzIxNjc5MH0.p8xsnlec7-ZbPJBfDDk1Wq0k8RqAzzsL6bK7BOtLp_jY1NgQvdAO5Yra647-94JV2cY8Vbe5H7zObia3S9oQ9dFXrnmSSSYs3_x7e_-vkaNcwx1Ev3J7lymqnH8Xc73s-TTGyebRlXiI714Ii62DJ_vKBEUvNM47V0H1FQk6xIfpzJAMMDRFZWO3MUvowgD4L-O6xre0RLapCYOSVtH_0CbM0VBfNkuwDAnF1kQeCtpWIvv_nETy7A-UdSox9GqtDp9h2Elkl-v3KJ8kEru7qT4fWZlsuzFPL7XzqkALCP39N7fxOpzlCfHYGPooLRHcFLGIPxpqi1bkfsn-Xk2BfQ"
      }
    }
  },
  "errors": {
  }
}
Note:

The execution URL and token for a real-time API Task have a limited lifespan. Based on the use case, you need to refresh the URL and token before it expires. For example: If you are calling them from an API client like Postman or from an external script, you need to refresh every 5 minutes.

Response parameters
Parameter Type Description
url String

URL - This is the container endpoint for your next request to deploy your API Task.
X-Authorization String Contains the token that you need to provide in the headers as X-Authorization.
Note:

Once you generate the API Task execution URL as well as the necessary headers to execute the API Task, you can send a deploy requests via the generated URL. If you specify inputs, make sure that for the automation to successfully receive these mapped-in values, the variable for that automation must be marked as input. Additionally, the name of the variable in the automation has to match the value that is being mapped in the request body.

Next steps

Next, Execute API Task real-time endpoint