Skip to main content
POST
Start Browser Session (async)

Authorizations

anchor-api-key
string
header
required

API key for your Anchor Browser account, sent as the anchor-api-key header on every request. Create one at app.anchorbrowser.io (API Access), or obtain one programmatically via the unauthenticated agent-access flow (POST /v1/agent-access).

Body

application/json
session
object

Session-related configurations.

browser
object

Browser-specific configurations.

integrations
object[]

Array of integrations to load in the browser session. Integrations must be previously created using the Integrations API.

Example:
identities
object[]

Activates an authenticated session.

Example:
identity_skip_validation
boolean
default:true

When true (default), skip profile validation for active identities and reuse the saved browser profile. Set to false to validate the profile and re-authenticate if it is no longer signed in. Pending identities still authenticate on first use.

identity_async_auth
boolean
default:false

Run identity authentication in the background and return the session immediately.

Response

Async session creation accepted; poll the status endpoint to resolve.

data
object