Skip to main content
GET
/
agent-profiles
Get agent profiles
curl --request GET \
  --url https://odyssey.asteroid.ai/api/v1/agent-profiles \
  --header 'X-Asteroid-Agents-Api-Key: <api-key>'
[
  {
    "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

Query Parameters

​
organization_id
string<uuid>

The ID of the organization to filter by

Response

List of agent profiles

​
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