The BrowserAct connector lets your AI agent act in each user's BrowserAct account. Each user connects their own BrowserAct access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 12 tools.
- Tools
- 12
- What they doRead · write · destructive
- 8 · 3 · 18 read3 write1 destructive
- Users sign in with
- Access token
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the BrowserAct connection
In AgentKit > Connections, create a BrowserAct connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'browseract'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize BrowserAct:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'browseract_bots_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "browseract"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize BrowserAct:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="browseract_bots_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their BrowserAct credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolbrowseract_bot_getGet one BrowserAct Bot by ID, including its published input and output schemas.Read-onlyGet Bot
Get one BrowserAct Bot by ID, including its published input and output schemas. Returns bot_id, bot_type, name, description, created_at, published_at, input_schema and output_schema (both null when unpublished). Use this before browseract_bot_run to build an input that matches input_schema. Use browseract_bots_list to find IDs.
Inputs
bot_idstringrequired- Public Bot ID. Get it from browseract_bots_list. Example: bot_8f2c1a7e4d.
browseract_bots_listList the Bots in your BrowserAct account that have a runnable published version, with optional type and name filters.Read-onlyList Bots
List the Bots in your BrowserAct account that have a runnable published version, with optional type and name filters. Returns items with bot_id, bot_type, name, description and published_at, plus page, limit, total_count and total_pages. Use this to find a bot_id. Use browseract_bot_get to see one Bot's input_schema before running it.
Inputs
bot_typestring- Only return Bots of this type. Example: workflow.one of
workflowagent keywordstring- Case-insensitive search on the Bot name, up to 200 characters. Example: amazon.
limitinteger- Bots per page, 1 to 100. BrowserAct defaults to 20. Example: 20.
pageinteger- Page number to retrieve, starting at 1. BrowserAct defaults to 1. Example: 1.
browseract_regions_listList the proxy regions your BrowserAct API key can use for template runs.Read-onlyList Proxy Regions
List the proxy regions your BrowserAct API key can use for template runs. Returns each region's code and name. Use this to pick proxy_region for browseract_template_run.
Inputs
This tool takes no inputs.
browseract_task_getGet the full details of one BrowserAct task, including its output.Read-onlyGet Task
Get the full details of one BrowserAct task, including its output. Returns status, the accepted input, output, failure details, files, live browser information and step summaries when available. Use this to read results once a task has finished. Use browseract_task_status_get for lightweight polling.
Inputs
task_idstringrequired- Task ID returned when the run was created, or from browseract_tasks_list. Example: 1990041234567890123.
browseract_task_status_getGet only the current status and last update time of one BrowserAct task.Read-onlyGet Task Status
Get only the current status and last update time of one BrowserAct task. Returns the task status (created, running, pausing, paused, finished, canceled or failed) and its update time. Use this to poll a run started by browseract_bot_run or browseract_template_run. Use browseract_task_get for the output.
Inputs
task_idstringrequired- Task ID returned when the run was created, or from browseract_tasks_list. Example: 1990041234567890123.
browseract_tasks_listList Bot runs (tasks) in your BrowserAct account, filtered by status, Bot or creation time, with pagination.Read-onlyList Tasks
List Bot runs (tasks) in your BrowserAct account, filtered by status, Bot or creation time, with pagination. Returns items with task_id, status, bot_id, bot_name and timestamps, plus page, limit, total_count and total_pages. Use this to browse past runs. Use browseract_task_get for one task's output.
Inputs
bot_idstring- Only return tasks created from this Bot ID. Example: bot_8f2c1a7e4d.
bot_namestring- Only return tasks whose Bot name contains this text. Example: amazon.
created_at_fromstring- Only tasks created at or after this time, ISO 8601. Example: 2026-01-01T00:00:00Z.
created_at_tostring- Only tasks created at or before this time, ISO 8601. Example: 2026-12-31T23:59:59Z.
limitinteger- Tasks per page, 1 to 100. BrowserAct defaults to 20. Example: 20.
pageinteger- Page number to retrieve, starting at 1. BrowserAct defaults to 1. Example: 1.
statusstring- Only return tasks with this status. Example: finished.one of
createdrunningfinishedcanceledpausingpausedfailed
browseract_template_getGet one official BrowserAct Bot template by ID.Read-onlyGet Official Template
Get one official BrowserAct Bot template by ID. Returns the template's ID, name, description and the input_schema a run must follow. Use this before browseract_template_run. Use browseract_templates_list to find IDs.
Inputs
template_idstringrequired- Public official Bot template ID. Get it from browseract_templates_list. Example: tpl_3a9d2e61b0.
browseract_templates_listList the official Bot templates curated by BrowserAct, with an optional name search.Read-onlyList Official Templates
List the official Bot templates curated by BrowserAct, with an optional name search. Returns items with each template's template_id, name and description, plus page, limit, total_count and total_pages. Use this to find a ready-made scraper. Use browseract_template_get for its input_schema.
Inputs
keywordstring- Case-insensitive search on the template name, up to 200 characters. Example: google maps.
limitinteger- Templates per page, 1 to 500. BrowserAct defaults to 10. Example: 10.
pageinteger- Page number to retrieve, starting at 1. BrowserAct defaults to 1. Example: 1.
browseract_bot_runStart a run (task) of a published BrowserAct Bot with the given input.WriteRun Bot
Start a run (task) of a published BrowserAct Bot with the given input. Returns the new task_id and its status, usually created or running; output is not ready yet. Poll browseract_task_status_get until the task finishes, then read the output with browseract_task_get. Use browseract_template_run for official templates.
Inputs
bot_idstringrequired- Public Bot ID. Get it from browseract_bots_list. Example: bot_8f2c1a7e4d.
inputobjectrequired- Run input object that matches the Bot's input_schema from browseract_bot_get. Send an empty object {} when the Bot takes no inputs. Example: {"keyword": "wireless earbuds", "max_items": 20}
callback_urlstring- Public HTTP or HTTPS URL that receives a POST with the full task details when the task finishes, fails or is canceled. Maximum 2048 characters; private or local addresses are rejected. Example: https://your-server.com/webhooks/browseract-done.
status_change_callback_urlstring- Public HTTP or HTTPS URL that receives a POST with the full task details every time the task status changes (running, paused, finished, canceled, failed). Maximum 2048 characters. Example: https://your-server.com/webhooks/browseract-status.
browseract_task_resumeAsk BrowserAct to resume a paused workflow task.WriteResume Task
Ask BrowserAct to resume a paused workflow task. Agent Bot tasks cannot be resumed. Returns the task's status; it can stay paused for a moment because resuming is asynchronous. Use this on a task in the paused state. Use browseract_task_cancel to stop a task instead.
- Idempotent
Inputs
task_idstringrequired- Task ID returned when the run was created, or from browseract_tasks_list. Example: 1990041234567890123.
browseract_template_runStart a run (task) of an official BrowserAct Bot template with the given input, optionally through a proxy region.WriteRun Official Template
Start a run (task) of an official BrowserAct Bot template with the given input, optionally through a proxy region. Returns the new task_id and its status; output is not ready yet. Poll browseract_task_status_get, then read the output with browseract_task_get. Use browseract_bot_run for your own Bots.
Inputs
inputobjectrequired- Run input object that matches the template's input_schema from browseract_template_get. Example: {"url": "https://example.com"}
template_idstringrequired- Public official Bot template ID. Get it from browseract_templates_list. Example: tpl_3a9d2e61b0.
callback_urlstring- Public HTTP or HTTPS URL that receives a POST with the full task details when the task finishes, fails or is canceled. Maximum 2048 characters; private or local addresses are rejected. Example: https://your-server.com/webhooks/browseract-done.
proxy_regionstring- Proxy region code to run the browser from. Get valid codes from browseract_regions_list. Example: US.
status_change_callback_urlstring- Public HTTP or HTTPS URL that receives a POST with the full task details every time the task status changes (running, paused, finished, canceled, failed). Maximum 2048 characters. Example: https://your-server.com/webhooks/browseract-status.
browseract_task_cancelCancel a running or paused BrowserAct task.DestructiveCancel Task
Cancel a running or paused BrowserAct task. A finished, canceled or failed task cannot be canceled. Returns the task's new status. Use this to stop a run you no longer need; a canceled task cannot be resumed.
- Idempotent
Inputs
task_idstringrequired- Task ID returned when the run was created, or from browseract_tasks_list. Example: 1990041234567890123.
biz_codeinteger- Optional cancellation code of your own for tracking. BrowserAct uses its default user-cancel code when left out. Example: 1001.
No tools match.