Create a browser profile

Create a blank browser profile, or create one from a persistent browser session or workflow run.

x-api-keystring nullable

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

Request body

namestring required

Name for the browser profile

descriptionstring nullable

Optional profile description

browser_session_idstring nullable

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

workflow_run_idstring nullable

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

proxy_session_idstring nullable

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

{
  "proxy_location": {
    "country": "US",
    "subdivision": "CA",
    "city": "New York"
  }
}

Successfully created browser profile

browser_profile_idstring required

organization_idstring required

namestring required

descriptionstring nullable

source_browser_typestring nullable

proxy_session_idstring nullable

is_managedboolean

workflow_permanent_idstring nullable

browser_profile_key_digeststring nullable

created_atstring date-time required

modified_atstring date-time required

deleted_atstring date-time nullable

{
  "proxy_location": {
    "country": "US",
    "subdivision": "CA",
    "city": "New York"
  }
}