AIairtop
windows

Execute an automation (async)

Changed on

Execute an automation of a browser window asynchronously

post/v1/async/sessions/{sessionId}/windows/{windowId}/execute-automation

Request

Path parameters

sessionIdstring required

The session id for the window.

windowIdstring required

The Airtop window id of the browser window.

Request body

automationIdstring required

The ID of the automation to execute

clientRequestIdstring
costThresholdCreditsinteger

A credit threshold that, once exceeded, will cause the operation to be cancelled. Note that this is not a hard limit, but a threshold that is checked periodically during the course of fulfilling the request. A default threshold is used if not specified, but you can use this option to increase or decrease as needed. Set to 0 to disable this feature entirely (not recommended).

parametersobject

Optional parameters to pass to the automation execution

timeThresholdSecondsinteger

A time threshold in seconds that, once exceeded, will cause the operation to be cancelled. Note that this is not a hard limit, but a threshold that is checked periodically during the course of fulfilling the request. A default threshold is used if not specified, but you can use this option to increase or decrease as needed. Set to 0 to disable this feature entirely (not recommended).

This setting does not extend the maximum session duration provided at the time of session creation.

Response

Created

requestIdstring required

Changes

  • f508c8a4c5e6Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security default was added to the API

  • 68dc554626c5Revision changes
    • info

      api operation id async-execute-automation removed and replaced with windows_async-execute-automation