Skyvern: Create a browser profile

Skyvern browserProfiles.createBrowserProfile: arguments, response, policy and SDK examples.

← Browser profiles operations · Get started

Operation skyvern.create_browser_profile_v1_browser_profiles_post

Provider route: POST /v1/browser_profiles. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/skyvern with npm, or alter-sdk-skyvern with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { SkyvernIntegration } from "@alter-ai/skyvern";

async function execute(input: Parameters<SkyvernIntegration["browserProfiles"]["createBrowserProfile"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new SkyvernIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.browserProfiles.createBrowserProfile(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_skyvern import SkyvernIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = SkyvernIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.browser_profiles.create_browser_profile(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`body`	Model	Required within parent	Expand Create a browser profile — request body — body

Referenced models: Create a browser profile — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	Model	Root	Expand Get browser profile — response body

Referenced models: Get browser profile — response body

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 — 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 an agent — response body — proxy location city, country, is ISP, subdivision

Field	Type	Presence	Description and constraints
`$`	object	Root	Granular proxy geo-targeting request with country, optional subdivision, and optional city.
`city`	JSON	Optional	City name in English from GeoNames (e.g., 'New York', 'Los Angeles', 'London')
`city (anyOf 1)`	string	Alternative	Maximum length: 100
`city (anyOf 2)`	null	Alternative
`country`	string	Required within parent	ISO 3166-1 alpha-2 country code (e.g., 'US', 'GB', 'DE') Maximum length: 2 Minimum length: 2
`isISP`	boolean	Optional	Whether this geo target is marked as an ISP proxy location. Default: false
`subdivision`	JSON	Optional	ISO 3166-2 subdivision code without country prefix (e.g., 'CA' for California, 'NY' for New York)
`subdivision (anyOf 1)`	string	Alternative	Maximum length: 10
`subdivision (anyOf 2)`	null	Alternative

Update an agent — response body — proxy location string

Field	Type	Presence	Description and constraints
`$`	string	Root	Known values: 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

Policy, approvals and errors

SDK function policy ID: skyvern.create_browser_profile_v1_browser_profiles_post. Catalog operation: create_browser_profile_v1_browser_profiles_post. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source

Report an issue with this page