---
canonical_url: "https://docs.composio.dev/toolkits/browseract"
markdown_url: "https://docs.composio.dev/toolkits/browseract.md"
product: "platform"
version: null
last_updated: null
---

# BrowserAct

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

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

## Tools

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | string | Yes | 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 | No | Caller-defined cancellation code recorded for tracking or analytics. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | string | Yes | Numeric task ID returned by RUN_WORKFLOW or RUN_WORKFLOW_TEMPLATE. |
| `detail_level` | string ("status" | "full") | No | Use status for lightweight polling, or full for progress, outputs, files, live-view details, and failures. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Workflow

**Slug:** `BROWSERACT_GET_WORKFLOW`

Return a custom workflow's metadata and expected input parameter definitions before a run.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workflow_id` | string | Yes | Custom workflow ID returned by LIST_WORKFLOWS. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Workflow Template

**Slug:** `BROWSERACT_GET_WORKFLOW_TEMPLATE`

Return an official template's metadata and expected input parameter definitions before a run.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `include_description` | boolean | No | Whether to include the template's potentially very large HTML description in the response. |
| `workflow_template_id` | string | Yes | Official template ID returned by LIST_WORKFLOW_TEMPLATES. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Proxy Regions

**Slug:** `BROWSERACT_LIST_PROXY_REGIONS`

Return the supported proxy region names and codes for official template runs.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum tasks in this page (1-500). |
| `status` | string ("created" | "running" | "finished" | "canceled" | "pausing" | "paused" | "failed" | "unknown") | No | Return only tasks in this lifecycle status. |
| `next_cursor` | string | No | Opaque cursor from the previous response; when set, it restores the original filters and page size. |
| `workflow_id` | string | No | Return only tasks created from this workflow ID. |
| `created_at_to` | string | No | Inclusive ISO 8601 UTC upper bound for task creation time. |
| `workflow_name` | string | No | Case-insensitive partial workflow-name filter. |
| `created_at_from` | string | No | Inclusive ISO 8601 UTC lower bound for task creation time. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Workflows

**Slug:** `BROWSERACT_LIST_WORKFLOWS`

Return one cursor-controlled page of custom workflows in the connected workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum workflows in this page (1-500). |
| `next_cursor` | string | No | Opaque cursor from the previous response; when set, it restores the original page size. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Workflow Templates

**Slug:** `BROWSERACT_LIST_WORKFLOW_TEMPLATES`

Search official BrowserAct workflow templates and return one cursor-controlled page of summaries.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum templates in this page (1-500). |
| `keyword` | string | No | Search text matched against template names and descriptions. |
| `next_cursor` | string | No | Opaque cursor from the previous response; when set, it restores the original keyword and page size. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | string | Yes | ID of a task currently in paused state; use GET_TASK or LIST_TASKS to verify its state first. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `profile_id` | string | No | Profile ID from an earlier run whose browser cookies and state should be reused. |
| `workflow_id` | string | Yes | Custom workflow ID to run; use LIST_WORKFLOWS or GET_WORKFLOW to find it. |
| `callback_url` | string | No | Public HTTP or HTTPS URL to notify when the task reaches a terminal state. |
| `input_parameters` | array | No | Workflow inputs as name/value pairs whose names match the workflow definition. |
| `save_browser_data` | boolean | No | Whether to save browser cookies and state and return a reusable profile_id. |
| `status_change_callback_url` | string | No | Public HTTP or HTTPS URL to notify when task status changes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `callback_url` | string | No | Public HTTP or HTTPS URL to notify when the task reaches a terminal state; maximum 2048 characters. |
| `proxy_region` | string | No | Proxy region code accepted by BrowserAct, such as US or GB; use LIST_PROXY_REGIONS for supported values. |
| `input_parameters` | array | No | Template inputs as name/value pairs whose names match the template definition. |
| `workflow_template_id` | string | Yes | Official template ID to run; use LIST_WORKFLOW_TEMPLATES or GET_WORKFLOW_TEMPLATE to find it. |
| `status_change_callback_url` | string | No | Public HTTP or HTTPS URL to notify when task status changes; maximum 2048 characters. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |