API Referencev2 API (Current)Profiles

Create Profile

Profiles allow you to preserve the state of the browser between tasks.

They are most commonly used to allow users to preserve the log-in state in the agent between tasks. You’d normally create one profile per user and then use it for all their tasks.

You can create a new profile by calling this endpoint.

Authentication

X-Browser-Use-API-Keystring
API Key authentication via header

Request

This endpoint expects an object.
namestring or nullOptional<=100 characters
Optional name for the profile

Response

Successful Response
idstringformat: "uuid"
Unique identifier for the profile
createdAtdatetime
Timestamp when the profile was created
updatedAtdatetime
Timestamp when the profile was last updated
namestring or null
Optional name for the profile
lastUsedAtdatetime or null
Timestamp when the profile was last used
cookieDomainslist of strings or null
List of domain URLs that have cookies stored for this profile

Errors