Skip to main content
PATCH
/
v1
/
browserbase
/
automations
/
{automationId}
Update a browser automation
curl --request PATCH \
  --url http://localhost:3333/v1/browserbase/automations/{automationId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "targetUrl": "<string>",
  "instruction": "<string>",
  "evaluationCriteria": "<string>",
  "schedule": "<string>",
  "isEnabled": true
}
'
{
  "id": "<string>",
  "name": "<string>",
  "taskId": "<string>",
  "targetUrl": "<string>",
  "instruction": "<string>",
  "isEnabled": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "schedule": "<string>"
}

Authorizations

X-API-Key
string
header
required

API key for authentication

Path Parameters

automationId
string
required

Automation ID

Body

application/json
name
string

Automation name

description
string

Automation description

targetUrl
string

Target URL to start from

instruction
string

Natural language instruction

evaluationCriteria
string

Optional natural-language criteria used to evaluate the automation result. Pass an empty string to clear.

schedule
string

Cron schedule expression

isEnabled
boolean

Whether automation is enabled

Response

200 - application/json

Automation updated

id
string
required
name
string
required
taskId
string
required
targetUrl
string
required
instruction
string
required
isEnabled
boolean
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
description
string
schedule
string