Skip to main content
Browserbase logo
  • Category: web scraping & browser
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 73
  • Triggers: 0
  • Slug: BROWSERBASE_TOOL
  • Version: 20261101_00

Tools

Slug: BROWSERBASE_TOOL_ATTACH_FUNCTION_SECRETAttach an existing project secret to a Function by UUID. Takes effect on the Function’s next invocation. Re-attaching an already attached secret succeeds. Returns a local success confirmation for HTTP 204 No Content, HTTP 400 for invalid UUIDs, or HTTP 404 if the Function or secret does not exist in the project.

Input Parameters

string
required
The UUID of the Function to attach the secret to.
string
required
The UUID of the project secret to attach (the id returned by POST /v1/secrets). Re-attaching an already-attached secret succeeds.

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: BROWSERBASE_TOOL_CONTEXTS_CREATEDeprecated compatibility action. Use CREATE_CONTEXT.

Input Parameters

string
required
The Project ID. Can be found in Settings.

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: BROWSERBASE_TOOL_CONTEXTS_GETDeprecated compatibility action. Use GET_CONTEXT.

Input Parameters

string
required
Unique identifier of the browser context to retrieve

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: BROWSERBASE_TOOL_CONTEXTS_UPDATETool to update a specific browser context. Use when you need fresh upload URL and encryption details for an existing context, after obtaining a valid context ID.

Input Parameters

string
required
The unique identifier of the browser context to update.

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: BROWSERBASE_TOOL_CREATE_AGENTCreate a reusable browser agent with a name and optional system prompt and result schema. Use the returned agentId when starting runs to reuse its configuration. An agent without a system prompt behaves like an unconfigured run.

Input Parameters

string
required
Human-readable name identifying the agent in the dashboard and API responses.
object
JSON Schema that runs using this agent aim to conform their result to. Can be overridden per run.
string
System prompt steering the agent’s behavior on every run that uses it.

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: BROWSERBASE_TOOL_CREATE_BROWSER_SESSIONDeprecated compatibility action. Use CREATE_SESSION.

Input Parameters

string
Region for the session, e.g. ‘us-west-2’, ‘us-east-1’.
object
Optional proxy configuration for the session.
integer
Session timeout in seconds.
boolean
Whether to keep the session alive after disconnection.
string
required
Project ID to associate with the browser session.
string
The ID of the custom extension to load.
object
Custom metadata object for the session. All values must be strings. The entire metadata object is limited to 512 characters when serialized to JSON. Note: The API has been observed to reject certain string patterns including URLs and strings containing ’://’ - use simple alphanumeric strings with underscores/hyphens. Examples: {‘purpose’: ‘navigation’, ‘env’: ‘staging’, ‘testId’: ‘test-123’}.

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: BROWSERBASE_TOOL_CREATE_CONTEXTCreate a reusable browser context; the API key can select the project.

Input Parameters

string
User-defined context name, unique within the project (1 to 128 characters)
string
Project for the context; inferred from the API key when omitted

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: BROWSERBASE_TOOL_CREATE_SESSIONCreate an isolated Browserbase session and return its connection details.

Input Parameters

string ("us-west-2" | "us-east-1" | "eu-central-1" | "ap-southeast-1")
Browserbase region in which to run the session
string
Use the default proxy or route domains through explicit proxy configurations
integer
Maximum session duration in seconds (60 to 21600)
boolean
Keep the session running after clients disconnect
string
Project for the session; inferred from the API key when omitted
string
Uploaded browser extension ID to load in the session
object
Arbitrary metadata used to identify and filter the session
object
Supplementary proxy certificate settings
object
Browser behavior, identity, recording, and viewport settings

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: BROWSERBASE_TOOL_CREATE_WEBHOOKRegister a publicly reachable HTTPS endpoint for project event deliveries. An endpoint can only be registered once per project. Store the signing secret returned here: it is only shown on creation and secret rotation.

Input Parameters

string
required
HTTPS URL that event deliveries are POSTed to. Must be publicly reachable.
array
required
Unique event types this webhook subscribes to. Unknown types are rejected.

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: BROWSERBASE_TOOL_DELETE_AGENTDelete a reusable browser agent by its agentId. Runs that already referenced the agent are unaffected. Deleting an already-deleted or nonexistent agent also succeeds. Returns an empty result.

Input Parameters

string
required
The agent ID.

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: BROWSERBASE_TOOL_DELETE_CONTEXTTool to delete a browser context and all its stored data (cookies, localStorage, etc.). Use when you need to permanently remove a context.

Input Parameters

string
required
Unique identifier of the browser context to delete

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: BROWSERBASE_TOOL_DELETE_DOWNLOADDelete a download file from storage and mark it as deleted. Supply the download ID. Returns an empty object on success.

Input Parameters

string
required
The download ID to delete.

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: BROWSERBASE_TOOL_DELETE_EXTENSIONTool to delete an uploaded browser extension by its ID. Use when you need to remove an extension from Browserbase.

Input Parameters

string
required
Unique identifier of the browser extension to delete

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: BROWSERBASE_TOOL_DELETE_SESSION_DOWNLOADSTool to delete all file downloads from a specific browser session. Use when you need to clean up session artifacts or free storage space.

Input Parameters

string
required
Unique identifier of the session to delete downloads from

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: BROWSERBASE_TOOL_DELETE_WEBHOOKDelete a webhook, immediately stopping deliveries and retiring its secret. Earlier events are not replayed if the endpoint is registered again.

Input Parameters

string
required
The webhook ID (UUID).

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: BROWSERBASE_TOOL_DETACH_FUNCTION_SECRETDetach a project secret from a Function by UUID. Takes effect on the Function’s next invocation. Detaching a secret that is not attached succeeds. Returns a local success confirmation for HTTP 204 No Content, HTTP 400 for invalid UUIDs, or HTTP 404 if the Function does not exist in the project. Does not delete the project secret.

Input Parameters

string
required
The UUID of the Function to detach the secret from.
string
required
The UUID of the project secret to detach. Detaching a secret that is not attached succeeds.

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: BROWSERBASE_TOOL_DOWNLOAD_SESSION_ARTIFACTSDownload a completed session’s generated files as a ZIP archive.

Input Parameters

string
required
Unique identifier of the session to download artifacts from

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: BROWSERBASE_TOOL_FETCH_PAGEFetch a page and return its content, headers, and metadata.

Input Parameters

string
required
The URL to fetch
string ("raw" | "json" | "markdown")
Output format for the response content. raw (default) returns the response body unchanged; json returns structured data (requires schema); markdown returns the page as markdown.
object
JSON Schema describing the desired structure of the response. Only used when format is json.
boolean
Whether to enable proxy support for the request
string
ID of a context whose persisted cookies are sent with the request.
boolean
Whether to follow HTTP redirects
boolean
Whether to bypass TLS certificate verification

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: BROWSERBASE_TOOL_GET_AGENTRetrieve a reusable browser agent by its agentId. Returns its name, timestamps, and configured system prompt and result schema.

Input Parameters

string
required
The agent ID.

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: BROWSERBASE_TOOL_GET_CERTIFICATERetrieve a Browserbase certificate by its ID. Returns the certificate’s ID, creation and update timestamps, and project ID.

Input Parameters

string
required
The unique identifier of the certificate.

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: BROWSERBASE_TOOL_GET_CONTEXTReturn metadata for a browser context by ID.

Input Parameters

string
required
Unique identifier of the browser context

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: BROWSERBASE_TOOL_GET_DOWNLOADGet a single download by ID as metadata or a downloadable file object. Select application/json for metadata or application/octet-stream for the file. This retrieves one file, rather than the ZIP of all session artifacts.

Input Parameters

string
required
The download ID.
string ("application/json" | "application/octet-stream")
Return JSON metadata (default) or a downloadable file object.

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: BROWSERBASE_TOOL_GET_EXTENSIONTool to retrieve details of a specific browser extension. Use when you have an extension ID and need its metadata (file name, timestamps, project ID).

Input Parameters

string
required
Unique identifier of the browser extension to retrieve

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: BROWSERBASE_TOOL_GET_FUNCTIONRetrieve a Browserbase function by its ID. Returns its name, owning project ID, and creation and update timestamps.

Input Parameters

string
required
UUID of the function to retrieve.

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: BROWSERBASE_TOOL_GET_FUNCTION_BUILDRetrieve a Browserbase function build by its build ID. Returns its status, original request, timestamps, and produced functions and versions or failure cause when available.

Input Parameters

string
required
The function build ID (UUID).

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: BROWSERBASE_TOOL_GET_FUNCTION_BUILD_LOGSRetrieve Browserbase function build logs by the build ID. Returns log messages, their numeric timestamps, and the total log count.

Input Parameters

string
required
The function build ID (UUID).

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: BROWSERBASE_TOOL_GET_FUNCTION_VERSIONRetrieve a Browserbase function version by its version ID. Returns its project, function, build, timestamps, and configured session creation parameters and user parameter schema when present.

Input Parameters

string
required
The function version ID (UUID).

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: BROWSERBASE_TOOL_GET_INVOCATIONRetrieve a Browserbase function invocation by its invocation ID. Returns its status, function and session IDs, timestamps, and execution region, parameters, results, and failure cause when present.

Input Parameters

string
required
The invocation ID (UUID).

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: BROWSERBASE_TOOL_GET_INVOCATION_LOGSRetrieve Browserbase function invocation logs by the invocation ID. Returns log messages, their numeric timestamps, and the total log count.

Input Parameters

string
required
The function invocation ID (UUID).

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: BROWSERBASE_TOOL_GET_KEYPAIRRetrieve the project’s public HPKE encryption key and keypair ID. Use publicKey to encrypt secret values before creating a secret, and pass the returned id as keypairId so decryption supports keypair rotation.

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: BROWSERBASE_TOOL_GET_PROJECTReturn project metadata, default timeout, and assigned concurrency.

Input Parameters

string
required
Unique identifier of the Browserbase project

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: BROWSERBASE_TOOL_GET_PROJECT_USAGETool to retrieve usage statistics for a project including browser minutes and proxy bytes consumed. Use when you need to monitor or track resource usage for a specific project.

Input Parameters

string
required
Unique identifier of the project to retrieve usage statistics for

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: BROWSERBASE_TOOL_GET_RUNRetrieve a browser agent run’s current status, result, and session details. Use List Run Messages separately to retrieve the run’s messages.

Input Parameters

string
required
The run ID.

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: BROWSERBASE_TOOL_GET_SECRETRetrieve a project secret’s ID and name by UUID, without its secret value. Returns HTTP 400 for an invalid UUID and HTTP 404 if the secret does not exist in the project.

Input Parameters

string
required
The UUID of the project secret to retrieve.

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: BROWSERBASE_TOOL_GET_SESSIONReturn status, connection details, and timestamps for a browser session.

Input Parameters

string
required
Unique identifier of the browser session

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: BROWSERBASE_TOOL_GET_SESSION_DEBUG_URLSReturn live debugger and WebSocket URLs for a running browser session.

Input Parameters

string
required
Unique identifier of the running session
integer
Live-view URL lifetime in seconds, up to 21600

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: BROWSERBASE_TOOL_GET_SESSION_LOGSReturn network request and response events captured during a browser session.

Input Parameters

string
required
Unique identifier of the browser session

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: BROWSERBASE_TOOL_GET_SESSION_REPLAYReturn HLS replay metadata and page playlist paths for a recorded session.

Input Parameters

string
required
Unique identifier of the recorded session

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: BROWSERBASE_TOOL_GET_SESSION_REPLAY_PAGEReturn the HLS M3U8 playlist for one recorded replay page. Consume its short-lived signed media URLs promptly rather than storing them.

Input Parameters

string
required
Unique identifier of the recorded session
string
required
Recorded page ID from Get Session Replay

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: BROWSERBASE_TOOL_GET_WEBHOOKRetrieve a single webhook by ID, without its signing secret. The signing secret is only returned when creating a webhook or rotating it.

Input Parameters

string
required
The webhook ID (UUID).

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: BROWSERBASE_TOOL_INVOKE_FUNCTIONInvoke a deployed Browserbase function asynchronously. Returns the accepted invocation (HTTP 202), not its eventual result. Optionally pass function parameters and configure its browser session.

Input Parameters

string
required
UUID of the function to invoke.
object
JSON object passed to the function.
object
Session configuration for this invocation.

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: BROWSERBASE_TOOL_LIST_AGENTSList one page of reusable browser agents across your account. Filter by inclusive creation timestamps using startAt and endAt. Pass the returned nextCursor as cursor to continue paging until nextCursor is null.

Input Parameters

string
Only return agents created on or before this inclusive RFC 3339 timestamp, e.g. 2026-01-20T00:00:00Z.
integer
Maximum number of results to return. Browserbase defaults to 20 when omitted.
string
Pagination cursor from a previous response’s nextCursor. Omit for the first page.
string
Only return agents created on or after this inclusive RFC 3339 timestamp, e.g. 2026-01-19T00:00:00Z.

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: BROWSERBASE_TOOL_LIST_CERTIFICATESList Browserbase certificates with their IDs, timestamps, and project IDs.

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: BROWSERBASE_TOOL_LIST_DOWNLOADSList one page of download metadata for a required browser session. Filter by exact filename, MIME type, file size, or inclusive creation timestamps. Use limit and offset to paginate through the total matches.

Input Parameters

integer
Maximum results to return (1-100). Browserbase defaults to 20 when omitted.
integer
Number of results to skip. Browserbase defaults to 0 when omitted.
number
Maximum file size in bytes.
number
Minimum file size in bytes.
string
Filter by exact filename match.
string
Filter by MIME type.
string
required
Session ID whose downloads to list.
string
Only return downloads created on or after this RFC 3339 timestamp.
string
Only return downloads created on or before this RFC 3339 timestamp.

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: BROWSERBASE_TOOL_LIST_FUNCTION_BUILDSList one page of Browserbase function builds, optionally filtered by status. Use offset and limit to paginate; total reports the number of matching builds. Results include build status, timestamps, and any built functions or failure cause.

Input Parameters

integer
Maximum builds to return. Browserbase defaults to 20 when omitted.
integer
Builds to skip. Browserbase defaults to 0 when omitted.
string
Filter builds by status (a free-form string).

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: BROWSERBASE_TOOL_LIST_FUNCTIONSList one page of Browserbase functions and the total number available. Use offset and limit to paginate. Pass a returned function id to invoke it.

Input Parameters

integer
Maximum number of functions to return. Browserbase defaults to 20 when omitted.
integer
Number of functions to skip. Browserbase defaults to 0 when omitted.

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: BROWSERBASE_TOOL_LIST_FUNCTION_SECRETSList one page of secret IDs and names attached to a Browserbase function, optionally filtered by creation time. Pass nextCursor as cursor with the same filters to continue paging; a null nextCursor means there are no more results.

Input Parameters

string
required
UUID of the function whose attached secrets to list.
string
Only return secrets created on or before this inclusive RFC 3339 timestamp, e.g. 2026-01-20T00:00:00Z.
integer
Maximum results to return (1-1000). Browserbase defaults to 20 when omitted.
string
Pass nextCursor from the previous response to fetch the next page. Keep the same filters across pages. Omit for the first page.
string
Only return secrets created on or after this inclusive RFC 3339 timestamp, e.g. 2026-01-19T00:00:00Z.

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: BROWSERBASE_TOOL_LIST_FUNCTION_VERSIONSList one page of versions for a Browserbase function by its UUID. Use offset and limit to page through results; total reports the total number of versions. Each version includes its build ID and stored parameter schemas.

Input Parameters

string
required
UUID of the function whose versions to list.
integer
Maximum versions to return (1-100). Browserbase defaults to 20 when omitted.
integer
Number of versions to skip. Browserbase defaults to 0 when omitted.

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: BROWSERBASE_TOOL_LIST_PROJECTSList projects with their default timeout and assigned concurrency.

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: BROWSERBASE_TOOL_LIST_RECORDING_DOWNLOADSPoll per-page MP4 assembly after requesting recording downloads until every page is COMPLETED or FAILED. Completed standard-storage pages may include short-lived signed MP4 URLs; BYOS pages may complete without a URL.

Input Parameters

string
required
Unique identifier of a completed session

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: BROWSERBASE_TOOL_LIST_RUN_MESSAGESList a page of a browser agent run’s messages, oldest first, with assistant or tool roles and text or typed content parts. Pass nextSince as since to continue paging or poll for new messages; use all to ignore the page limit.

Input Parameters

boolean
Return every message after since, ignoring limit. Provider default is false.
integer
Maximum messages to return; omission uses the provider default of 20.
string
required
The run ID (UUID).
string
Last received message ID. Omit initially; pass nextSince to page or poll for newer messages.

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: BROWSERBASE_TOOL_LIST_RUNSList a page of browser agent runs across your account. Filter by status, referenced agent, or inclusive creation-time bounds. Continue pagination by passing the returned nextCursor as cursor.

Input Parameters

string
Inclusive creation-time upper bound in RFC 3339 format, e.g. 2026-01-20T00:00:00Z.
integer
Maximum results to return. Omission uses the provider default of 20.
string
Pass nextCursor from the previous response to continue paging; omit for the first page.
string ("PENDING" | "RUNNING" | "COMPLETED" | "FAILED" | "STOPPED" | "TIMED_OUT" | "PAUSED")
Filter by current run status; PAUSED awaits caller input.
string
Only return runs referencing this agent ID.
string
Inclusive creation-time lower bound in RFC 3339 format, e.g. 2026-01-19T00:00:00Z.

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: BROWSERBASE_TOOL_LIST_SECRETSList one page of project secret IDs and names, optionally filtered by creation time. Does not return secret values. Pass nextCursor as cursor to fetch the next page; a null nextCursor means there are no more results. Time bounds are inclusive.

Input Parameters

string
Only return secrets created on or before this timestamp (inclusive). RFC 3339, e.g. 2026-01-20T00:00:00Z.
integer
Maximum number of results to return. Browserbase defaults to 20.
string
Pagination cursor. Pass nextCursor from the previous response to fetch the next page. Omit to start from the first page.
string
Only return secrets created on or after this timestamp (inclusive). RFC 3339, e.g. 2026-01-19T00:00:00Z.

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: BROWSERBASE_TOOL_LIST_SESSIONSList browser sessions, optionally filtered by status or user metadata.

Input Parameters

string ("PENDING" | "RUNNING" | "ERROR" | "TIMED_OUT" | "COMPLETED")
Return only sessions with this lifecycle status
string
Filter by user metadata, for example user_metadata[‘env’]:‘prod’

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: BROWSERBASE_TOOL_LIST_VERSION_INVOCATIONSList one page of invocations for a Browserbase function version by its UUID. Filter by status and paginate using offset and limit. Each invocation includes its status, function and session IDs, timestamps, and any stored results.

Input Parameters

string
required
UUID of the function version whose invocations to list.
integer
Maximum invocations to return (1-100). Browserbase defaults to 20 when omitted.
integer
Number of invocations to skip. Browserbase defaults to 0 when omitted.
string
Filter invocations by status.

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: BROWSERBASE_TOOL_LIST_WEBHOOKSList one page of the project’s webhooks, newest first, without signing secrets. Pass nextCursor as cursor to fetch the next page. A null nextCursor ends paging.

Input Parameters

integer
Maximum results to return. Defaults to 20 on the server.
string
Previous response’s nextCursor. Omit for the first page.

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: BROWSERBASE_TOOL_RELEASE_SESSIONIrreversibly request release of a running browser session, ending it before its configured timeout to avoid further charges.

Input Parameters

string
required
Unique identifier of the running browser session to release
string
Project linked to the session; inferred from the API key when omitted

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: BROWSERBASE_TOOL_REQUEST_RECORDING_DOWNLOADSStart asynchronous MP4 assembly for every recorded page of a completed session, then poll List Recording Downloads until every page is COMPLETED or FAILED.

Input Parameters

string
required
Unique identifier of a completed session

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: BROWSERBASE_TOOL_RESUME_RUNResume only a PAUSED browser agent run with optional additional input. The task answers its trailing pause tool call; variables merge over the run’s original variables. A run that is not PAUSED returns HTTP 409 conflict. Returns the accepted RUNNING run; poll the run for its next state.

Input Parameters

string
Reply to the agent’s request for input in its trailing pause tool call.
string
required
The run ID.
object
Named %variable% placeholders merged over the run’s original variables. Values are not persisted.

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: BROWSERBASE_TOOL_RUN_AGENTStart a browser agent run to complete a task using web search and browser tools. Returns the newly created pending run, not its eventual result. Optionally use a custom agent, configure its browser, supply variables, or enable pauses.

Input Parameters

string
required
Natural language description of the task to accomplish.
string
Custom agent ID. Uses its systemPrompt and resultSchema unless overridden.
string
When to pause awaiting application input. Enables the pause tool; resume via the resume endpoint.
object
Named %variable% placeholders with values and optional hints. Values are not persisted.
object
JSON Schema for the result; overrides the referenced agent’s default for this run.
object
Browser configuration for the session. Omission uses runner defaults.

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: BROWSERBASE_TOOL_SESSIONS_GETDeprecated compatibility action. Use GET_SESSION.

Input Parameters

string
required
Unique identifier of the browser session to retrieve

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: BROWSERBASE_TOOL_SESSIONS_GET_DEBUGDeprecated compatibility action. Use GET_SESSION_DEBUG_URLS.

Input Parameters

string
required
Unique identifier of the session to retrieve debug URLs for

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: BROWSERBASE_TOOL_SESSIONS_GET_DOWNLOADSDeprecated compatibility action. Use DOWNLOAD_SESSION_ARTIFACTS.

Input Parameters

string
required
Unique identifier of the session to download artifacts from

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: BROWSERBASE_TOOL_SESSIONS_GET_LOGSDeprecated compatibility action. Use GET_SESSION_LOGS.

Input Parameters

string
required
Unique identifier of the session to retrieve logs for

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: BROWSERBASE_TOOL_SESSIONS_LISTDeprecated compatibility action. Use LIST_SESSIONS.

Input Parameters

string
Query sessions by user metadata. Format: user_metadata[‘key’]:‘value’ or for nested keys: user_metadata[‘key1’][‘key2’]:‘value’.
string ("RUNNING" | "ERROR" | "TIMED_OUT" | "COMPLETED")
Filter sessions by status. Available options: RUNNING, ERROR, TIMED_OUT, COMPLETED.

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: BROWSERBASE_TOOL_SESSIONS_UPDATEDeprecated compatibility action. Use RELEASE_SESSION.

Input Parameters

string
required
Unique identifier of the browser session to update
string
required
Set to REQUEST_RELEASE to request that the session complete before its timeout
string
required
The Project ID linked to the session

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: BROWSERBASE_TOOL_STOP_RUNRequest that an in-progress browser agent run stop. Returns the run after the stop request is accepted, not confirmation that it has stopped. The run winds down and transitions to STOPPED; poll Get Run until its status is STOPPED to confirm. Already-finished runs return HTTP 409 conflict.

Input Parameters

string
required
The run ID.

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: BROWSERBASE_TOOL_UPDATE_AGENTUpdate a reusable browser agent’s name, system prompt, or result schema. Only supplied fields are modified; omitted fields remain unchanged. Returns the updated agent, whose defaults apply to subsequent runs referencing it.

Input Parameters

string
Human-readable agent name used in the dashboard and API responses.
string
required
The ID of the agent to update.
object
JSON Schema that agent runs aim to match in their result; may be overridden per run.
string
New system prompt steering every run that uses this agent.

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: BROWSERBASE_TOOL_UPDATE_WEBHOOKUpdate a webhook’s delivery URL, subscribed event types, or both. Omitted fields stay unchanged. Event types replace the existing subscription rather than adding to it. The signing secret is unaffected and not returned.

Input Parameters

string
required
The webhook ID (UUID).
string
Publicly reachable HTTPS URL that event deliveries are POSTed to. Omit to leave unchanged.
array
Subscribed event types. Replaces the existing subscription; omit to leave unchanged. Values must be unique.

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: BROWSERBASE_TOOL_UPLOAD_EXTENSIONTool to upload a browser extension for use in sessions. Supports Chrome extension format (ZIP). Use when you need to add custom browser extensions to your Browserbase project.

Input Parameters

object
required
The browser extension file to upload (ZIP format).

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: BROWSERBASE_TOOL_UPLOAD_SESSION_FILEUpload one file so browser interactions can select it in a file input field.

Input Parameters

string
required
Unique identifier of the session to upload the file to
object
required
File to upload.

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: BROWSERBASE_TOOL_UPLOAD_SESSION_FILESUpload multiple files to one browser session for file-input interactions. Reports per-file outcomes when at least one upload succeeds; a batch-level provider error can stop further attempts.

Input Parameters

string
required
Unique identifier of the browser session receiving the files
array
required
Files to upload for browser file-input interactions

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: BROWSERBASE_TOOL_WEB_SEARCHPerform a web search and return structured results.

Input Parameters

string ("fast" | "advanced" | "deep-lite" | "deep")
The search mode used by the underlying provider. See https://docs.browserbase.com/platform/search/overview for available modes and defaults. Requires provider: parallel supports fast/advanced; exa supports fast/deep-lite/deep.
string
required
The search query string
string ("parallel" | "exa")
Search provider to serve this request. Omit to use the default provider for your project (parallel).
integer
Number of results to return (1-25). Defaults to 10 when omitted.

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