Create Agent Profile

Create a new agent profile

POST /agent-profiles

Create Agent Profile

cURL

curl --request POST \
  --url https://odyssey.asteroid.ai/agents/v2/agent-profiles \
  --header 'Content-Type: application/json' \
  --header 'X-Asteroid-Agents-Api-Key: <api-key>' \
  --data '
{
  "description": "<string>",
  "name": "<string>",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "adblockActive": false,
  "cachePersistence": false,
  "captchaSolverActive": false,
  "cookies": [
    {
      "domain": "<string>",
      "httpOnly": true,
      "key": "<string>",
      "name": "<string>",
      "sameSite": "Strict",
      "secure": true,
      "value": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "expiry": "2023-11-07T05:31:56Z",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "credentials": [
    {
      "data": "<string>",
      "name": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "customProxy": {
    "password": "<string>",
    "server": "<string>",
    "username": "<string>"
  },
  "extraStealth": false,
  "forcePopupsAsTabsActive": true,
  "mediaBlockerActive": false,
  "operatingSystem": "macos",
  "pdfViewerActive": false,
  "popupBlockerActive": false,
  "proxyCC": "us",
  "proxyMode": "none",
  "proxyType": "basic",
  "stickyIP": false
}
'

201

{
  "adblockActive": true,
  "cachePersistence": true,
  "captchaSolverActive": true,
  "cookies": [
    {
      "domain": "<string>",
      "httpOnly": true,
      "key": "<string>",
      "name": "<string>",
      "sameSite": "Strict",
      "secure": true,
      "value": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "expiry": "2023-11-07T05:31:56Z",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "credentials": [
    {
      "data": "<string>",
      "name": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "description": "<string>",
  "extraStealth": true,
  "forcePopupsAsTabsActive": true,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "mediaBlockerActive": true,
  "name": "<string>",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pdfViewerActive": true,
  "popupBlockerActive": true,
  "proxyMode": "none",
  "stickyIP": true,
  "updatedAt": "2023-11-07T05:31:56Z",
  "customProxy": {
    "server": "<string>",
    "username": "<string>"
  },
  "operatingSystem": "macos",
  "proxyCC": "us",
  "proxyType": "basic"
}

Authorizations

X-Asteroid-Agents-Api-Key · string · header · required

Body

application/json

Agent profile to create

Request to create a new agent profile

description · string · required

Description of the agent profile

Maximum string length: 1000

name · string · required

Name of the agent profile (must be unique within organization)

Required string length: 1 - 255

organizationId · string<uuid> · required

The ID of the organization that the profile belongs to

adblockActive · boolean · default: false

Whether to enable ad blocking

cachePersistence · boolean · default: false

Whether to persist browser cache between sessions

captchaSolverActive · boolean · default: false

Whether the captcha solver should be active (managed proxy only)

cookies · object[]

Initial cookies to create with the profile

Show child attributes

credentials · object[]

Initial credentials to create with the profile

Show child attributes

customProxy · object

Custom proxy configuration (required for custom proxy mode)

Show child attributes

extraStealth · boolean · default: false

Whether to enable extra stealth mode

forcePopupsAsTabsActive · boolean · default: true

Whether to force popups to open as tabs

mediaBlockerActive · boolean · default: false

Whether to enable media blocking (images, videos, etc.)

operatingSystem · enum<string>

Operating system to emulate

Available options: macos, windows

pdfViewerActive · boolean · default: false

Whether to enable the built-in PDF viewer (if disabled, PDFs are downloaded)

popupBlockerActive · boolean · default: false

Whether to enable popup blocking (requires adblock to be active)

proxyCC · enum<string>

Country code for proxy location (for managed proxy mode)

Available options: us, uk, fr, it, jp, au, de, fi, ca

proxyMode · enum<string> · default: none

Proxy configuration mode

Available options: none, managed, custom

proxyType · enum<string>

Type of managed proxy to use (required for managed proxy mode)

Available options: basic, residential, mobile

stickyIP · boolean · default: false

Whether to use the same IP address for all executions (managed proxy only)

Response

201

application/json

The request has succeeded and a new resource has been created as a result.

An agent profile containing browser configuration and credentials

adblockActive · boolean · required

Whether to enable ad blocking

cachePersistence · boolean · required

Whether to persist browser cache between sessions

captchaSolverActive · boolean · required

Whether the captcha solver is active for this profile (managed proxy only)

cookies · object[] · required

List of cookies associated with this profile

Show child attributes

createdAt · string<date-time> · required

When the profile was created

credentials · object[] · required

List of credentials associated with this profile

Show child attributes

description · string · required

Description of the agent profile

extraStealth · boolean · required

Whether extra stealth mode is enabled

forcePopupsAsTabsActive · boolean · required

Whether to force popups to open as tabs

id · string<uuid> · required

Unique identifier for the agent profile

mediaBlockerActive · boolean · required

Whether to enable media blocking (images, videos, etc.)

name · string · required

Name of the agent profile (unique within organization)

organizationId · string<uuid> · required

The ID of the organization that owns this profile

pdfViewerActive · boolean · required

Whether to enable the built-in PDF viewer (if disabled, PDFs are downloaded)

popupBlockerActive · boolean · required

Whether to enable popup blocking (requires adblock to be active)

proxyMode · enum<string> · required

Proxy configuration mode

Available options: none, managed, custom

stickyIP · boolean · required

Whether to use the same IP address for all executions (managed proxy only)

updatedAt · string<date-time> · required

When the profile was last updated

customProxy · object

Custom proxy configuration (for custom proxy mode, password excluded)

Show child attributes

operatingSystem · enum<string>

Operating system to emulate

Available options: macos, windows

proxyCC · enum<string>

Country code for proxy location (for managed proxy mode)

Available options: us, uk, fr, it, jp, au, de, fi, ca

proxyType · enum<string>

Type of managed proxy to use (for managed proxy mode)

Available options: basic, residential, mobile