Skip to main content
POST
/
agent-profiles
Create an agent profile
curl --request POST \
  --url https://odyssey.asteroid.ai/api/v1/agent-profiles \
  --header 'Content-Type: application/json' \
  --header 'X-Asteroid-Agents-Api-Key: <api-key>' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "proxy_cc": "us",
  "proxy_type": "basic",
  "captcha_solver_active": false,
  "sticky_ip": false,
  "credentials": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "data": "<string>",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "cookies": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "key": "<string>",
      "value": "<string>",
      "expiry": "2023-11-07T05:31:56Z",
      "domain": "<string>",
      "secure": true,
      "same_site": "Strict",
      "http_only": true,
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "tracing_snapshots": true,
  "extra_stealth": false
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "proxy_cc": "us",
  "proxy_type": "basic",
  "captcha_solver_active": true,
  "sticky_ip": true,
  "credentials": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "data": "<string>",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "cookies": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "key": "<string>",
      "value": "<string>",
      "expiry": "2023-11-07T05:31:56Z",
      "domain": "<string>",
      "secure": true,
      "same_site": "Strict",
      "http_only": true,
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "tracing_snapshots": true,
  "extra_stealth": true
}

Authorizations

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

Body

application/json
​
name
string
required

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

Required string length: 1 - 255
​
description
string
required

Description of the agent profile

Maximum length: 1000
​
organization_id
string<uuid>
required

The ID of the organization that the agent profile belongs to

​
proxy_cc
enum<string>
required

Two-letter country code for proxy location

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

Type of proxy to use

Available options:
basic,
residential,
mobile
​
captcha_solver_active
boolean
default:false
required

Whether the captcha solver should be active for this profile

​
sticky_ip
boolean
default:false
required

Whether the same IP address should be used for all executions of this profile

​
credentials
object[]
required

Optional list of credentials to create with the profile

​
cookies
object[]
required

Optional list of cookies to create with the profile

​
tracing_snapshots
boolean
default:true

Whether to enable tracing snapshots for the profile

​
extra_stealth
boolean
default:false

Whether to enable extra stealth for the profile

Response

Agent profile created successfully

​
id
string<uuid>
required

Unique identifier for the agent profile

​
name
string
required

Name of the agent profile (unique within organization)

​
description
string
required

Description of the agent profile

​
organization_id
string<uuid>
required

The ID of the organization that the agent profile belongs to

​
captcha_solver_active
boolean
required

Whether the captcha solver is active for this profile

​
sticky_ip
boolean
required

Whether the same IP address should be used for all executions of this profile

​
credentials
object[]
required

List of credentials associated with this agent profile

​
cookies
object[]
required

List of cookies associated with this agent profile

​
created_at
string<date-time>
required

The date and time the agent profile was created

​
updated_at
string<date-time>
required

The last update time of the agent profile

​
tracing_snapshots
boolean
required

Whether to enable tracing snapshots for the profile

​
extra_stealth
boolean
required

Whether to enable extra stealth for the profile

​
proxy_cc
enum<string>

Two-letter country code for proxy location

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

Type of proxy to use

Available options:
basic,
residential,
mobile