BRbrowserbase

Resume a Run

Changed on

Resume a PAUSED run with additional input. The reply in task is delivered to the agent as the answer to its pause request (the trailing pause tool call in the run's messages), and variables merge over the run's original variables. Resuming a run that is not paused returns a conflict.

post/v1/agents/runs/{runId}/resume

Request

  • Base URL
    https://api.browserbase.com
  • Auth
    API key in header X-BB-API-Key

Path parameters

runIdstring required

The run ID.

Request body

taskstring

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.

variablesobject

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.

Response

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

runIdstring required

Unique identifier for the run.

agentIdstring

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

taskstring required

The original task description.

status'PENDING' | 'RUNNING' | 'COMPLETED' | 'FAILED' | 'STOPPED' | 'TIMED_OUT' | 'PAUSED' 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
sessionIdstring

The Browserbase session ID powering this run.

sandboxIdstring

External sandbox identifier assigned by the runner. Optional.

resultSchemaobject

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

resultobject

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.

startedAtstring date-time
endedAtstring date-time
createdAtstring date-time required
updatedAtstring date-time required

Changes