POST
/
v1
/
profiles
curl --request POST \
  --url https://api.anchorbrowser.io/v1/profiles \
  --header 'Content-Type: application/json' \
  --header 'anchor-api-key: <api-key>' \
  --data '{
  "name": "my-profile",
  "description": "This is my profile description.",
  "source": "session",
  "session_id": "550e8400-e29b-41d4-a716-446655440000",
  "store_cache": true
}'
{
  "data": {
    "status": "success"
  }
}

Authorizations

​
anchor-api-key
string
header
required

API key passed in the header

Body

application/json
​
name
string
required

The name of the profile.

Example:

"my-profile"

​
description
string

A description of the profile.

Example:

"This is my profile description."

​
source
enum<string>

The source of the profile data. currently only session is supported.

Available options:
session
Example:

"session"

​
session_id
string

The browser session ID is required if the source is set to session. The browser session must be running, and the profile will be stored once the browser session terminates.

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
store_cache
boolean

Indicates whether the browser session cache should be saved when the browser session ends. Defaults to false.

Example:

true

Response

200
application/json
Profile created successfully.
​
data
object

Details of the created profile.