BRbrowserbase

Stop a Run

Changed on

Request that an in-progress run stop. The run winds down and transitions to STOPPED. Stopping a run that has already finished returns a conflict.

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

Request

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

Path parameters

runIdstring required

The run ID.

Response

The stop has been requested. Poll the run until its status is STOPPED to confirm it wound down.

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