Add Browserbase to your AI agent

Get 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.

Tool to retrieve details of a specific browser extension. Use when you have an extension ID and need its metadata (file name, timestamps, project ID).

Retrieve a Browserbase function build by its build ID. Returns its status, original request, timestamps, and produced functions and versions or failure cause when available.

Retrieve Browserbase function build logs by the build ID. Returns log messages, their numeric timestamps, and the total log count.

Retrieve 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.

Retrieve 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.

Retrieve Browserbase function invocation logs by the invocation ID. Returns log messages, their numeric timestamps, and the total log count.

Return project metadata, default timeout, and assigned concurrency.

Tool 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.

Retrieve a browser agent run's current status, result, and session details. Use List Run Messages separately to retrieve the run's messages.

Return status, connection details, and timestamps for a browser session.

Return live debugger and WebSocket URLs for a running browser session.

Return network request and response events captured during a browser session.

Return HLS replay metadata and page playlist paths for a recorded session.

Return the HLS M3U8 playlist for one recorded replay page. Consume its short-lived signed media URLs promptly rather than storing them.

Retrieve a single webhook by ID, without its signing secret. The signing secret is only returned when creating a webhook or rotating it.

List 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.

List Browserbase certificates with their IDs, timestamps, and project IDs.

List 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.

List 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.

List 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.

List one page of Browserbase functions and the total number available. Use offset and limit to paginate. Pass a returned function id to invoke it.

List projects with their default timeout and assigned concurrency.

Poll 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.

List one page of a browser agent run's messages, oldest first. Messages follow the AI SDK UIMessage format. Pass nextSince as since to continue paging or poll for new messages. Use all to ignore the page limit.

List 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.

List browser sessions, optionally filtered by status or user metadata.

List 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.

List 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.

Irreversibly request release of a running browser session, ending it before its configured timeout to avoid further charges.

Start asynchronous MP4 assembly for every recorded page of a completed session, then poll List Recording Downloads until every page is COMPLETED or FAILED.

Resume 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.

Start 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.

Request 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.

Tool 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.

Upload one file so browser interactions can select it in a file input field.

Upload multiple files to one browser session for file-input interactions. Each file is attempted independently and the response reports partial failures.

Perform a web search and return structured results.

Attach 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.

Tool to delete a browser context and all its stored data (cookies, localStorage, etc.). Use when you need to permanently remove a context.

Tool to delete an uploaded browser extension by its ID. Use when you need to remove an extension from Browserbase.

Tool to delete all file downloads from a specific browser session. Use when you need to clean up session artifacts or free storage space.

Delete a webhook, immediately stopping deliveries and retiring its secret. Earlier events are not replayed if the endpoint is registered again.

Detach 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.

Retrieve a Browserbase function by its ID. Returns its name, owning project ID, and creation and update timestamps.

Retrieve 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.

Retrieve 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.

Invoke a deployed Browserbase function asynchronously. Returns the accepted invocation (HTTP 202), not its eventual result. Optionally pass function parameters and configure its browser session.

List one page of secret IDs and names attached to a Browserbase function. Returns metadata only, never secret values. Creation-time filters are inclusive. Pass nextCursor as cursor with the same filters to continue paging; a null nextCursor means there are no more results.

List 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.

Update 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.

Update 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.