Create a browser automation

POST /v1/browserbase/automations

Create a browser automation

cURL

curl --request POST \
  --url http://localhost:3333/v1/browserbase/automations \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --header 'X-Organization-Id: <x-organization-id>' \
  --data '
{
  "taskId": "<string>",
  "name": "<string>",
  "targetUrl": "<string>",
  "instruction": "<string>",
  "description": "<string>",
  "schedule": "<string>"
}
'

201

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

Headers

X-Organization-Id · string · required

Organization ID (required for session auth)

Body

application/json

taskId · string · required

Task ID this automation belongs to

name · string · required

Automation name

targetUrl · string · required

Target URL to start from

instruction · string · required

Natural language instruction for navigation

description · string

Automation description

schedule · string

Cron schedule expression

Response

201 - application/json

Automation created

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