List Runs

GET

agents

runs

Node.js

import Browserbase from "@browserbasehq/sdk";

const bb = new Browserbase({
  apiKey: process.env.BROWSERBASE_API_KEY,
});

const runs = await bb.agents.runs.list({
  status: "COMPLETED",
  limit: 20,
});

console.log(runs);

curl --request GET \
  --url https://api.browserbase.com/v1/agents/runs \
  --get \
  --data-urlencode 'status=COMPLETED' \
  --data-urlencode 'limit=20' \
  --header "X-BB-API-Key: $BROWSERBASE_API_KEY"

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.browserbase.com/v1/agents/runs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-BB-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.browserbase.com/v1/agents/runs"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-BB-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.browserbase.com/v1/agents/runs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-BB-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "runId": "<string>",
      "task": "<string>",
      "status": "PENDING",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "agentId": "<string>",
      "sessionId": "<string>",
      "sandboxId": "<string>",
      "resultSchema": {},
      "result": {},
      "cause": {
        "code": "<string>",
        "message": "<string>"
      },
      "startedAt": "2023-11-07T05:31:56Z",
      "endedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "limit": 123,
  "nextCursor": "<string>"
}

Authorizations

X-BB-API-Key

string

header

required

Your Browserbase API Key.

Query Parameters

status

enum<string>

Current status of the run.

PENDING - agent will run soon
RUNNING - agent is currently running
COMPLETED - agent has finished running
FAILED - agent has failed the run
STOPPED - run was stopped by the user
TIMED_OUT - run exceeded maximum time
PAUSED - run is paused awaiting input from the caller; the agent's request is the trailing pause tool call in the run's messages

Available options:

PENDING,

RUNNING,

COMPLETED,

FAILED,

STOPPED,

TIMED_OUT,

PAUSED

agentId

string

Only return runs that reference this agent ID.

startAt

string<date-time>

Only return runs created on or after this timestamp (inclusive). RFC 3339, e.g. 2026-01-19T00:00:00Z.

endAt

string<date-time>

Only return runs created on or before this timestamp (inclusive). RFC 3339, e.g. 2026-01-20T00:00:00Z.

limit

integer

default:20

Maximum number of results to return.

Required range: 1 <= x <= 1000

cursor

string

Pagination cursor. Pass the nextCursor from the previous response to fetch the next page. Omit to start from the first page.

Response

200 - application/json

The page of matching agent runs.

A page of agent runs.

data

object[]

required

The page of matching agent runs.

Show child attributes

limit

integer

required

The maximum number of results returned in this page.

nextCursor

string | null

required

Cursor for the next page. Pass it back as cursor on the next request to continue paging. null when there are no more results.

⌘I

Node.js

import Browserbase from "@browserbasehq/sdk";

const bb = new Browserbase({
  apiKey: process.env.BROWSERBASE_API_KEY,
});

const runs = await bb.agents.runs.list({
  status: "COMPLETED",
  limit: 20,
});

console.log(runs);

curl --request GET \
  --url https://api.browserbase.com/v1/agents/runs \
  --get \
  --data-urlencode 'status=COMPLETED' \
  --data-urlencode 'limit=20' \
  --header "X-BB-API-Key: $BROWSERBASE_API_KEY"

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.browserbase.com/v1/agents/runs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-BB-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.browserbase.com/v1/agents/runs"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-BB-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.browserbase.com/v1/agents/runs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-BB-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "runId": "<string>",
      "task": "<string>",
      "status": "PENDING",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "agentId": "<string>",
      "sessionId": "<string>",
      "sandboxId": "<string>",
      "resultSchema": {},
      "result": {},
      "cause": {
        "code": "<string>",
        "message": "<string>"
      },
      "startedAt": "2023-11-07T05:31:56Z",
      "endedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "limit": 123,
  "nextCursor": "<string>"
}

Overview

SDKs

APIs

Authorizations

Query Parameters

Response