Skip to main content
POST
/
v1
/
browser_profiles
Create a browser profile
curl --request POST \
  --url https://api.skyvern.com/v1/browser_profiles \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "browser_session_id": "<string>",
  "workflow_run_id": "<string>",
  "proxy_session_id": "<string>"
}
'
{
  "browser_profile_id": "<string>",
  "organization_id": "<string>",
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "source_browser_type": "<string>",
  "proxy_session_id": "<string>",
  "deleted_at": "2023-11-07T05:31:56Z"
}

Headers

​
x-api-key
string | null

Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.

Body

application/json
​
name
string
required

Name for the browser profile

Minimum string length: 1
​
description
string | null

Optional profile description

​
browser_session_id
string | null

Persistent browser session to convert into a profile. Omit for a blank profile.

Minimum string length: 1
​
workflow_run_id
string | null

Workflow run whose persisted session should be captured. Omit for a blank profile.

Minimum string length: 1
​
proxy_location

Optional proxy location for this profile's pinned proxy identity.

Available options:
RESIDENTIAL,
US-CA,
US-NY,
US-TX,
US-FL,
US-WA,
RESIDENTIAL_ES,
RESIDENTIAL_IE,
RESIDENTIAL_GB,
RESIDENTIAL_IN,
RESIDENTIAL_JP,
RESIDENTIAL_FR,
RESIDENTIAL_DE,
RESIDENTIAL_NZ,
RESIDENTIAL_ZA,
RESIDENTIAL_AR,
RESIDENTIAL_AU,
RESIDENTIAL_BR,
RESIDENTIAL_TR,
RESIDENTIAL_CA,
RESIDENTIAL_MX,
RESIDENTIAL_IT,
RESIDENTIAL_NL,
RESIDENTIAL_PH,
RESIDENTIAL_KR,
RESIDENTIAL_SA,
RESIDENTIAL_ISP,
NONE
​
proxy_session_id
string | null

Explicit sticky-session id for this profile's pinned proxy identity.

Response

Successfully created browser profile

​
browser_profile_id
string
required
​
organization_id
string
required
​
name
string
required
​
created_at
string<date-time>
required
​
modified_at
string<date-time>
required
​
description
string | null
​
source_browser_type
string | null
​
proxy_location
Available options:
RESIDENTIAL,
US-CA,
US-NY,
US-TX,
US-FL,
US-WA,
RESIDENTIAL_ES,
RESIDENTIAL_IE,
RESIDENTIAL_GB,
RESIDENTIAL_IN,
RESIDENTIAL_JP,
RESIDENTIAL_FR,
RESIDENTIAL_DE,
RESIDENTIAL_NZ,
RESIDENTIAL_ZA,
RESIDENTIAL_AR,
RESIDENTIAL_AU,
RESIDENTIAL_BR,
RESIDENTIAL_TR,
RESIDENTIAL_CA,
RESIDENTIAL_MX,
RESIDENTIAL_IT,
RESIDENTIAL_NL,
RESIDENTIAL_PH,
RESIDENTIAL_KR,
RESIDENTIAL_SA,
RESIDENTIAL_ISP,
NONE
​
proxy_session_id
string | null
​
deleted_at
string<date-time> | null