Skip to main content
BrowserAct logo
  • Category: web scraping & browser
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 11
  • Triggers: 0
  • Slug: BROWSERACT
  • Version: 20261030_00

Tools

Slug: BROWSERACT_CANCEL_TASKImmediately 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

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.
integer
Caller-defined cancellation code recorded for tracking or analytics.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BROWSERACT_GET_TASKReturn either a task’s current status or its full progress, outputs, files, live-view details, and failure information.

Input Parameters

string
required
Numeric task ID returned by RUN_WORKFLOW or RUN_WORKFLOW_TEMPLATE.
string ("status" | "full")
Use status for lightweight polling, or full for progress, outputs, files, live-view details, and failures.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BROWSERACT_GET_WORKFLOWReturn a custom workflow’s metadata and expected input parameter definitions before a run.

Input Parameters

string
required
Custom workflow ID returned by LIST_WORKFLOWS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BROWSERACT_GET_WORKFLOW_TEMPLATEReturn an official template’s metadata and expected input parameter definitions before a run.

Input Parameters

boolean
Whether to include the template’s potentially very large HTML description in the response.
string
required
Official template ID returned by LIST_WORKFLOW_TEMPLATES.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BROWSERACT_LIST_PROXY_REGIONSReturn the supported proxy region names and codes for official template runs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BROWSERACT_LIST_TASKSReturn one cursor-controlled page of workflow tasks, optionally filtered by status, workflow, name, or creation time.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BROWSERACT_LIST_WORKFLOWSReturn one cursor-controlled page of custom workflows in the connected workspace.

Input Parameters

integer
Maximum workflows in this page (1-500).
string
Opaque cursor from the previous response; when set, it restores the original page size.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BROWSERACT_LIST_WORKFLOW_TEMPLATESSearch official BrowserAct workflow templates and return one cursor-controlled page of summaries.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BROWSERACT_RESUME_TASKResume 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

string
required
ID of a task currently in paused state; use GET_TASK or LIST_TASKS to verify its state first.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BROWSERACT_RUN_WORKFLOWStart a custom BrowserAct workflow. This consumes credits and executes its configured browser actions, which may irreversibly modify external websites.

Input Parameters

string
Profile ID from an earlier run whose browser cookies and state should be reused.
string
required
Custom workflow ID to run; use LIST_WORKFLOWS or GET_WORKFLOW to find it.
string
Public HTTP or HTTPS URL to notify when the task reaches a terminal state.
array
Workflow inputs as name/value pairs whose names match the workflow definition.
boolean
Whether to save browser cookies and state and return a reusable profile_id.
string
Public HTTP or HTTPS URL to notify when task status changes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BROWSERACT_RUN_WORKFLOW_TEMPLATEStart an official BrowserAct workflow template. This consumes credits and executes its browser actions, which may cause irreversible effects on external websites.

Input Parameters

string
Public HTTP or HTTPS URL to notify when the task reaches a terminal state; maximum 2048 characters.
string
Proxy region code accepted by BrowserAct, such as US or GB; use LIST_PROXY_REGIONS for supported values.
array
Template inputs as name/value pairs whose names match the template definition.
string
required
Official template ID to run; use LIST_WORKFLOW_TEMPLATES or GET_WORKFLOW_TEMPLATE to find it.
string
Public HTTP or HTTPS URL to notify when task status changes; maximum 2048 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not