Resume a Run

POST

agents

runs

{runId}

resume

cURL

curl --request POST \
  --url https://api.browserbase.com/v1/agents/runs/run-id/resume \
  --header 'Content-Type: application/json' \
  --header "X-BB-API-Key: $BROWSERBASE_API_KEY" \
  --data '{
    "task": "The code is %code%",
    "variables": { "code": { "value": "123456" } }
  }'

import requests

url = "https://api.browserbase.com/v1/agents/runs/{runId}/resume"

payload = {
    "task": "<string>",
    "variables": {}
}
headers = {
    "X-BB-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-BB-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({task: '<string>', variables: {}})
};

fetch('https://api.browserbase.com/v1/agents/runs/{runId}/resume', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.browserbase.com/v1/agents/runs/{runId}/resume",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'task' => '<string>',
    'variables' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.browserbase.com/v1/agents/runs/{runId}/resume"

	payload := strings.NewReader("{\n  \"task\": \"<string>\",\n  \"variables\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-BB-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.browserbase.com/v1/agents/runs/{runId}/resume")
  .header("X-BB-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"task\": \"<string>\",\n  \"variables\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["X-BB-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"task\": \"<string>\",\n  \"variables\": {}\n}"

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

{
  "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"
}

Authorizations

X-BB-API-Key

string

header

required

Your Browserbase API Key.

Path Parameters

runId

string

required

The run ID.

Body

application/json

task

string

Additional input for the agent: the reply to its request for input, which is the trailing pause tool call in the run's messages (e.g. an answer or an approval). Delivered to the agent as the result of that pause call.

Minimum string length: 1

variables

object

Optional named variables the agent can reference as placeholders, i.e. %variable%. Each entry pairs a value the placeholder resolves to with an optional description that hints to the agent when it should be used. Values are not persisted.

Show child attributes

Response

202 - application/json

The resume has been accepted and the run is RUNNING again. Poll the run for its next state.

One execution of an agent against a task. Created in pending and transitioned through running → completed/failed by the runner.

runId

string

required

Unique identifier for the run.

task

string

required

The original task description.

status

enum<string>

required

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

createdAt

string<date-time>

required

updatedAt

string<date-time>

required

agentId

string

The ID of the agent applied to this run, if any. Omitted for ad-hoc runs.

sessionId

string

The Browserbase session ID powering this run.

sandboxId

string

External sandbox identifier assigned by the runner. Optional.

resultSchema

object

Per-run JSON Schema override for the result shape. When unset, the agent's default resultSchema applies.

result

object

The agent's structured result for the run. Only present when the run has finished and output is available. The result conforms to the provided JSON Schema when one is set.

cause

object

Show child attributes

startedAt

string<date-time>

endedAt

string<date-time>

⌘I

cURL

curl --request POST \
  --url https://api.browserbase.com/v1/agents/runs/run-id/resume \
  --header 'Content-Type: application/json' \
  --header "X-BB-API-Key: $BROWSERBASE_API_KEY" \
  --data '{
    "task": "The code is %code%",
    "variables": { "code": { "value": "123456" } }
  }'

import requests

url = "https://api.browserbase.com/v1/agents/runs/{runId}/resume"

payload = {
    "task": "<string>",
    "variables": {}
}
headers = {
    "X-BB-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-BB-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({task: '<string>', variables: {}})
};

fetch('https://api.browserbase.com/v1/agents/runs/{runId}/resume', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.browserbase.com/v1/agents/runs/{runId}/resume",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'task' => '<string>',
    'variables' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.browserbase.com/v1/agents/runs/{runId}/resume"

	payload := strings.NewReader("{\n  \"task\": \"<string>\",\n  \"variables\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-BB-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.browserbase.com/v1/agents/runs/{runId}/resume")
  .header("X-BB-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"task\": \"<string>\",\n  \"variables\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["X-BB-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"task\": \"<string>\",\n  \"variables\": {}\n}"

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

{
  "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"
}

Overview

SDKs

APIs

Authorizations

Path Parameters

Body

Response