Skyvern: Browser profiles schemas
6 Skyvern schemas with complete fields and constraints.
← Browser profiles operations · All schemas
Create a browser profile — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
browser_session_id | JSON | Optional | Persistent browser session to convert into a profile. Omit for a blank profile. |
browser_session_id (anyOf 1) | string | Alternative | Minimum length: 1 |
browser_session_id (anyOf 2) | null | Alternative | |
description | JSON | Optional | Optional profile description |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
name | string | Required within parent | Name for the browser profile Minimum length: 1 |
proxy_location | JSON | Optional | Optional proxy location for this profile's pinned proxy identity. |
proxy_location (anyOf 1) | string | Alternative | One of: 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_location (anyOf 2) | Model | Alternative | Expand Update an agent — response body — proxy location city, country, is ISP, subdivision |
proxy_location (anyOf 3) | object | Alternative | Additional keys: allowed |
proxy_location (anyOf 4) | null | Alternative | |
proxy_session_id | JSON | Optional | Explicit sticky-session id for this profile's pinned proxy identity. |
proxy_session_id (anyOf 1) | string | Alternative | |
proxy_session_id (anyOf 2) | null | Alternative | |
workflow_run_id | JSON | Optional | Workflow run whose persisted session should be captured. Omit for a blank profile. |
workflow_run_id (anyOf 1) | string | Alternative | Minimum length: 1 |
workflow_run_id (anyOf 2) | null | Alternative |
Referenced models: Update an agent — response body — proxy location city, country, is ISP, subdivision
Get browser profile usage — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
credentials | array | Optional | Default: [] |
credentials[] | Model | Each item | Expand Get browser profile usage — response body — credentials item |
recent_seeded_run_count | JSON | Optional | |
recent_seeded_run_count (anyOf 1) | integer | Alternative | Default: 0 |
recent_seeded_run_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
workflows | array | Optional | Default: [] |
workflows[] | Model | Each item | Expand Get browser profile usage — response body — workflows item |
Referenced models: Get browser profile usage — response body — credentials item, Get browser profile usage — response body — workflows item
Get browser profile usage — response body — credentials item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
credential_id | string | Required within parent | |
name | string | Required within parent |
Get browser profile usage — response body — workflows item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
title | string | Required within parent | |
via | string | Required within parent | |
workflow_permanent_id | string | Required within parent |
Get browser profile — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
browser_profile_id | string | Required within parent | |
browser_profile_key_digest | JSON | Optional | |
browser_profile_key_digest (anyOf 1) | string | Alternative | |
browser_profile_key_digest (anyOf 2) | null | Alternative | |
created_at | string | Required within parent | Format: date-time |
deleted_at | JSON | Optional | |
deleted_at (anyOf 1) | string | Alternative | Format: date-time |
deleted_at (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
is_managed | boolean | Optional | Default: false |
last_verified_login_at | JSON | Optional | |
last_verified_login_at (anyOf 1) | string | Alternative | Format: date-time |
last_verified_login_at (anyOf 2) | null | Alternative | |
linked_credential_id | JSON | Optional | |
linked_credential_id (anyOf 1) | string | Alternative | |
linked_credential_id (anyOf 2) | null | Alternative | |
linked_credential_name | JSON | Optional | |
linked_credential_name (anyOf 1) | string | Alternative | |
linked_credential_name (anyOf 2) | null | Alternative | |
modified_at | string | Required within parent | Format: date-time |
name | string | Required within parent | |
organization_id | string | Required within parent | |
proxy_location | JSON | Optional | |
proxy_location (anyOf 1) | Model | Alternative | Expand Update an agent — response body — proxy location string |
proxy_location (anyOf 2) | Model | Alternative | Expand Update an agent — response body — proxy location city, country, is ISP, subdivision |
proxy_location (anyOf 3) | object | Alternative | Additional keys: allowed |
proxy_location (anyOf 4) | null | Alternative | |
proxy_session_id | JSON | Optional | |
proxy_session_id (anyOf 1) | string | Alternative | |
proxy_session_id (anyOf 2) | null | Alternative | |
source_browser_type | JSON | Optional | |
source_browser_type (anyOf 1) | string | Alternative | |
source_browser_type (anyOf 2) | null | Alternative | |
workflow_permanent_id | JSON | Optional | |
workflow_permanent_id (anyOf 1) | string | Alternative | |
workflow_permanent_id (anyOf 2) | null | Alternative |
Referenced models: Update an agent — response body — proxy location city, country, is ISP, subdivision, Update an agent — response body — proxy location string
Update browser profile — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | JSON | Optional | New description for the browser profile |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
name | JSON | Optional | New name for the browser profile |
name (anyOf 1) | string | Alternative | Minimum length: 1 |
name (anyOf 2) | null | Alternative | |
proxy_location | JSON | Optional | Optional proxy location for this profile's pinned proxy identity. |
proxy_location (anyOf 1) | string | Alternative | One of: 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_location (anyOf 2) | Model | Alternative | Expand Update an agent — response body — proxy location city, country, is ISP, subdivision |
proxy_location (anyOf 3) | object | Alternative | Additional keys: allowed |
proxy_location (anyOf 4) | null | Alternative | |
proxy_session_id | JSON | Optional | Opaque Skyvern-managed proxy sticky-session id. |
proxy_session_id (anyOf 1) | string | Alternative | |
proxy_session_id (anyOf 2) | null | Alternative | |
rotate_proxy_session_id | boolean | Optional | Rotate the Skyvern-managed proxy sticky-session id for this profile. Default: false |
Referenced models: Update an agent — response body — proxy location city, country, is ISP, subdivision