Browser Profiles

Create a browser profile

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

post/v1/browser_profiles

Headers

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.

Example request

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

Response

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

last_verified_login_atstring date-time nullable

linked_credential_namestring nullable

Example response

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

Changes

Changed in 7 of the 86 revisions of this API.818

Jul 24, 2026bd64e0480f0a1See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
Jul 22, 20265987635eae7d1See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
Jul 7, 2026fdc175c3bb8c3See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
Jun 26, 20269de266eb002a4See the full diff
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
Jun 26, 202693aa0351ee142See the full diff
- ▲
  the / request property's minLength was increased from 0 to 1
  request-property-min-length-increased
- ▲
  the / request property's minLength was increased from 0 to 1
  request-property-min-length-increased
Jun 8, 20263a3616091b6668See the full diff
- ▲
  the request property became not nullable
  request-property-became-not-nullable
- ▲
  the request property became not nullable
  request-property-became-not-nullable
- ▲
  the request property became not nullable
  request-property-became-not-nullable
- ▲
  the request property's minLength was increased from 0 to 1
  request-property-min-length-increased
- ▲
  response property deleted_at list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property description list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ○
  header request parameter x-api-key list-of-types was widened by adding types null
  request-parameter-list-of-types-widened
- ○
  for the header request parameter x-api-key, the type was generalized from string to no type
  request-parameter-type-generalized
- ○
  request property list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 4, 2026a8899e7707c41See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history