> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# BrowserAct

> BrowserAct runs hosted browser-automation workflows and exposes task execution, workflow discovery, templates, and proxy-region APIs.

![BrowserAct logo](https://mintcdn.com/composio-preview/PudKL42NVsy5O-ND/images/toolkits/browseract.svg?fit=max\&auto=format\&n=PudKL42NVsy5O-ND\&q=85\&s=74390e82247cd1060fc07a5b7d80ddc7)

* **Category:** web scraping & browser
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 11
* **Triggers:** 0
* **Slug:** `BROWSERACT`
* **Version:** 20261030\_00

## Tools

> [accordion] Cancel Task
>
> **Slug:** `BROWSERACT_CANCEL_TASK`
>
> Immediately and permanently cancel a running BrowserAct task. The canceled run cannot be resumed or recovered. A task already in a terminal state is also treated as successfully canceled.
>
> #### Input Parameters
>
> **task\_id** `string` *required*
>
> ID of a running task to cancel. Use BROWSERACT\_GET\_TASK or BROWSERACT\_LIST\_TASKS to verify the task first because cancellation is immediate and permanent.
>
> **business\_code** `integer`
>
> Caller-defined cancellation code recorded for tracking or analytics.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Task
>
> **Slug:** `BROWSERACT_GET_TASK`
>
> Return either a task's current status or its full progress, outputs, files, live-view details, and failure information.
>
> #### Input Parameters
>
> **task\_id** `string` *required*
>
> Numeric task ID returned by RUN\_WORKFLOW or RUN\_WORKFLOW\_TEMPLATE.
>
> **detail\_level** `string ("status" | "full")`
>
> Use status for lightweight polling, or full for progress, outputs, files, live-view details, and failures.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Workflow
>
> **Slug:** `BROWSERACT_GET_WORKFLOW`
>
> Return a custom workflow's metadata and expected input parameter definitions before a run.
>
> #### Input Parameters
>
> **workflow\_id** `string` *required*
>
> Custom workflow ID returned by LIST\_WORKFLOWS.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Workflow Template
>
> **Slug:** `BROWSERACT_GET_WORKFLOW_TEMPLATE`
>
> Return an official template's metadata and expected input parameter definitions before a run.
>
> #### Input Parameters
>
> **include\_description** `boolean`
>
> Whether to include the template's potentially very large HTML description in the response.
>
> **workflow\_template\_id** `string` *required*
>
> Official template ID returned by LIST\_WORKFLOW\_TEMPLATES.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Proxy Regions
>
> **Slug:** `BROWSERACT_LIST_PROXY_REGIONS`
>
> Return the supported proxy region names and codes for official template runs.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Tasks
>
> **Slug:** `BROWSERACT_LIST_TASKS`
>
> Return one cursor-controlled page of workflow tasks, optionally filtered by status, workflow, name, or creation time.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum tasks in this page (1-500).
>
> **status** `string ("created" | "running" | "finished" | "canceled" | "pausing" | "paused" | "failed" | "unknown")`
>
> Return only tasks in this lifecycle status.
>
> **next\_cursor** `string`
>
> Opaque cursor from the previous response; when set, it restores the original filters and page size.
>
> **workflow\_id** `string`
>
> Return only tasks created from this workflow ID.
>
> **created\_at\_to** `string`
>
> Inclusive ISO 8601 UTC upper bound for task creation time.
>
> **workflow\_name** `string`
>
> Case-insensitive partial workflow-name filter.
>
> **created\_at\_from** `string`
>
> Inclusive ISO 8601 UTC lower bound for task creation time.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Workflows
>
> **Slug:** `BROWSERACT_LIST_WORKFLOWS`
>
> Return one cursor-controlled page of custom workflows in the connected workspace.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum workflows in this page (1-500).
>
> **next\_cursor** `string`
>
> Opaque cursor from the previous response; when set, it restores the original page size.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Workflow Templates
>
> **Slug:** `BROWSERACT_LIST_WORKFLOW_TEMPLATES`
>
> Search official BrowserAct workflow templates and return one cursor-controlled page of summaries.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum templates in this page (1-500).
>
> **keyword** `string`
>
> Search text matched against template names and descriptions.
>
> **next\_cursor** `string`
>
> Opaque cursor from the previous response; when set, it restores the original keyword and page size.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Resume Task
>
> **Slug:** `BROWSERACT_RESUME_TASK`
>
> Resume a paused task from its current state. Finished, failed, and canceled tasks cannot be resumed. BrowserAct also treats an already-running task as a successful request.
>
> #### Input Parameters
>
> **task\_id** `string` *required*
>
> ID of a task currently in paused state; use GET\_TASK or LIST\_TASKS to verify its state first.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Run Workflow
>
> **Slug:** `BROWSERACT_RUN_WORKFLOW`
>
> Start a custom BrowserAct workflow. This consumes credits and executes its configured browser actions, which may irreversibly modify external websites.
>
> #### Input Parameters
>
> **profile\_id** `string`
>
> Profile ID from an earlier run whose browser cookies and state should be reused.
>
> **workflow\_id** `string` *required*
>
> Custom workflow ID to run; use LIST\_WORKFLOWS or GET\_WORKFLOW to find it.
>
> **callback\_url** `string`
>
> Public HTTP or HTTPS URL to notify when the task reaches a terminal state.
>
> **input\_parameters** `array`
>
> Workflow inputs as name/value pairs whose names match the workflow definition.
>
> **save\_browser\_data** `boolean`
>
> Whether to save browser cookies and state and return a reusable profile\_id.
>
> **status\_change\_callback\_url** `string`
>
> Public HTTP or HTTPS URL to notify when task status changes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Run Workflow Template
>
> **Slug:** `BROWSERACT_RUN_WORKFLOW_TEMPLATE`
>
> Start an official BrowserAct workflow template. This consumes credits and executes its browser actions, which may cause irreversible effects on external websites.
>
> #### Input Parameters
>
> **callback\_url** `string`
>
> Public HTTP or HTTPS URL to notify when the task reaches a terminal state; maximum 2048 characters.
>
> **proxy\_region** `string`
>
> Proxy region code accepted by BrowserAct, such as US or GB; use LIST\_PROXY\_REGIONS for supported values.
>
> **input\_parameters** `array`
>
> Template inputs as name/value pairs whose names match the template definition.
>
> **workflow\_template\_id** `string` *required*
>
> Official template ID to run; use LIST\_WORKFLOW\_TEMPLATES or GET\_WORKFLOW\_TEMPLATE to find it.
>
> **status\_change\_callback\_url** `string`
>
> Public HTTP or HTTPS URL to notify when task status changes; maximum 2048 characters.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
