Create Browsercode Run

const options = {
  method: 'POST',
  headers: {'X-Browser-Use-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    task: '<string>',
    model: '<string>',
    sessionId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    workspaceId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    browser: {
      profileId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      proxyCountryCode: 'us',
      customProxy: {
        host: '<string>',
        port: 32768,
        username: '<string>',
        password: '<string>',
        ignoreCertErrors: false
      },
      screenWidth: 3232,
      screenHeight: 1888,
      record: true
    },
    attachedFileIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    maxCostUsd: 1,
    judge: {context: '<string>'}
  })
};

fetch('https://api-staging-ufcbwvyv9yifyyvc3.browser-use.com/api/v1/agents/browsercode/runs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request POST \
  --url https://api-staging-ufcbwvyv9yifyyvc3.browser-use.com/api/v1/agents/browsercode/runs \
  --header 'Content-Type: application/json' \
  --header 'X-Browser-Use-API-Key: <api-key>' \
  --data '
{
  "task": "<string>",
  "model": "<string>",
  "sessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "browser": {
    "profileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "proxyCountryCode": "us",
    "customProxy": {
      "host": "<string>",
      "port": 32768,
      "username": "<string>",
      "password": "<string>",
      "ignoreCertErrors": false
    },
    "screenWidth": 3232,
    "screenHeight": 1888,
    "record": true
  },
  "attachedFileIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "maxCostUsd": 1,
  "judge": {
    "context": "<string>"
  }
}
'

import requests

url = "https://api-staging-ufcbwvyv9yifyyvc3.browser-use.com/api/v1/agents/browsercode/runs"

payload = {
    "task": "<string>",
    "model": "<string>",
    "sessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "browser": {
        "profileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "proxyCountryCode": "us",
        "customProxy": {
            "host": "<string>",
            "port": 32768,
            "username": "<string>",
            "password": "<string>",
            "ignoreCertErrors": False
        },
        "screenWidth": 3232,
        "screenHeight": 1888,
        "record": True
    },
    "attachedFileIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "maxCostUsd": 1,
    "judge": { "context": "<string>" }
}
headers = {
    "X-Browser-Use-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "id": "<string>",
  "sessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "missingFileIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}

{
  "detail": "Config is inherited on a continuation. Start a new session to change model/workspace/browser."
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

POST

agents

browsercode

runs

Create Browsercode Run

const options = {
  method: 'POST',
  headers: {'X-Browser-Use-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    task: '<string>',
    model: '<string>',
    sessionId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    workspaceId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    browser: {
      profileId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      proxyCountryCode: 'us',
      customProxy: {
        host: '<string>',
        port: 32768,
        username: '<string>',
        password: '<string>',
        ignoreCertErrors: false
      },
      screenWidth: 3232,
      screenHeight: 1888,
      record: true
    },
    attachedFileIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    maxCostUsd: 1,
    judge: {context: '<string>'}
  })
};

fetch('https://api-staging-ufcbwvyv9yifyyvc3.browser-use.com/api/v1/agents/browsercode/runs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request POST \
  --url https://api-staging-ufcbwvyv9yifyyvc3.browser-use.com/api/v1/agents/browsercode/runs \
  --header 'Content-Type: application/json' \
  --header 'X-Browser-Use-API-Key: <api-key>' \
  --data '
{
  "task": "<string>",
  "model": "<string>",
  "sessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "browser": {
    "profileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "proxyCountryCode": "us",
    "customProxy": {
      "host": "<string>",
      "port": 32768,
      "username": "<string>",
      "password": "<string>",
      "ignoreCertErrors": false
    },
    "screenWidth": 3232,
    "screenHeight": 1888,
    "record": true
  },
  "attachedFileIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "maxCostUsd": 1,
  "judge": {
    "context": "<string>"
  }
}
'

import requests

url = "https://api-staging-ufcbwvyv9yifyyvc3.browser-use.com/api/v1/agents/browsercode/runs"

payload = {
    "task": "<string>",
    "model": "<string>",
    "sessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "browser": {
        "profileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "proxyCountryCode": "us",
        "customProxy": {
            "host": "<string>",
            "port": 32768,
            "username": "<string>",
            "password": "<string>",
            "ignoreCertErrors": False
        },
        "screenWidth": 3232,
        "screenHeight": 1888,
        "record": True
    },
    "attachedFileIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "maxCostUsd": 1,
    "judge": { "context": "<string>" }
}
headers = {
    "X-Browser-Use-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "id": "<string>",
  "sessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "missingFileIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}

{
  "detail": "Config is inherited on a continuation. Start a new session to change model/workspace/browser."
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

X-Browser-Use-API-Key

string

header

required

Body

application/json

Start a new browsercode conversation OR continue an existing one.

ONE door. Omit session_id to start a new conversation (full config body). Pass session_id to continue a thread (MINIMAL body — config is inherited). Continuation never 409s on a busy session: the turn comes back queued and starts automatically when the current run finishes.

CONTINUATION RULE (enforced): passing session_id together with ANY config field (model / workspaceId / browser / judge / maxCostUsd) → 400. Config is inherited on a follow-up; start a new session to change it.

task

string

required

What you want the agent to do.

Minimum string length: 1

model

string | null

Model to run. New-conversation only — inherited on a continuation. Omit for the server default.

sessionId

string<uuid> | null

Continue this conversation. Files and config carry over; send a MINIMAL body (task + attachedFileIds). Omit to start a new conversation.

workspaceId

string<uuid> | null

ADVANCED + new-conversation only. Run in an explicit workspace to share files across sessions. Omit on the normal path.

browser

RunBrowserSettings · object | null

Browser/proxy/screen settings. New-conversation only (inherited on a follow-up).

Show child attributes

attachedFileIds

string<uuid>[] | null

Upload ids (from POST /agents/browsercode/files) to give THIS run. Allowed on both new and continuation runs.

Maximum array length: 20

maxCostUsd

USD cap for this run. New-conversation only; null → server default.

Required range: x > 0

judge

BrowsercodeJudgeSettings · object | null

Opt-in post-run LLM judge. New-conversation only.

Show child attributes

Response

Successful Response

Async run accepted. Poll GET /runs/{id}/status or GET /runs/{id} for progress + result.

string

required

Run id, e.g. "run_...".

agent

enum<string>

required

Which agent is running it.

Available options:

browser-use,

browsercode

sessionId

string<uuid>

required

The conversation this run belongs to (new or continued).

status

enum<string>

required

Initial state — 'queued' or 'running'.

Available options:

queued,

running,

completed,

failed,

stopped

workspaceId

string<uuid> | null

The run's workspace, if the agent has one (browsercode). Its files live here.

missingFileIds

string<uuid>[]

Attached upload ids that could not be confirmed in storage at creation. The run still starts.

Purge Browser Use Session

List Browsercode Runs

⌘I

Overview

Agents

Browsers

Agent Workspaces (Files)

Account

Create Browsercode Run

Authorizations

Body

Response