Skip to main content
POST
/
agent-profiles
Create Agent Profile
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",
  "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"
    }
  ],
  "extraStealth": false,
  "operatingSystem": "macos",
  "proxyCC": "us",
  "proxyType": "basic",
  "stickyIP": false
}
'
{
  "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,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "stickyIP": true,
  "updatedAt": "2023-11-07T05:31:56Z",
  "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

​
cachePersistence
boolean
default:false

Whether to persist browser cache between sessions

​
captchaSolverActive
boolean
default:false

Whether the captcha solver should be active

​
cookies
object[]

Initial cookies to create with the profile

​
credentials
object[]

Initial credentials to create with the profile

​
extraStealth
boolean
default:false

Whether to enable extra stealth mode

​
operatingSystem
enum<string>

Operating system to emulate

Available options:
macos,
windows
​
proxyCC
enum<string>

Country code for proxy location

Available options:
us,
uk,
fr,
it,
jp,
au,
de,
fi,
ca
​
proxyType
enum<string>

Type of proxy to use

Available options:
basic,
residential,
mobile
​
stickyIP
boolean
default:false

Whether to use the same IP address for all executions

Response

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

An agent profile containing browser configuration and credentials

​
cachePersistence
boolean
required

Whether to persist browser cache between sessions

​
captchaSolverActive
boolean
required

Whether the captcha solver is active for this profile

​
cookies
object[]
required

List of cookies associated with this profile

​
createdAt
string<date-time>
required

When the profile was created

​
credentials
object[]
required

List of credentials associated with this profile

​
description
string
required

Description of the agent profile

​
extraStealth
boolean
required

Whether extra stealth mode is enabled

​
id
string<uuid>
required

Unique identifier for the agent profile

​
name
string
required

Name of the agent profile (unique within organization)

​
organizationId
string<uuid>
required

The ID of the organization that owns this profile

​
stickyIP
boolean
required

Whether to use the same IP address for all executions

​
updatedAt
string<date-time>
required

When the profile was last updated

​
operatingSystem
enum<string>

Operating system to emulate

Available options:
macos,
windows
​
proxyCC
enum<string>

Country code for proxy location

Available options:
us,
uk,
fr,
it,
jp,
au,
de,
fi,
ca
​
proxyType
enum<string>

Type of proxy to use

Available options:
basic,
residential,
mobile