Skip to main content
GET
/
agent-profiles
List Agent Profiles
curl --request GET \
  --url https://odyssey.asteroid.ai/agents/v2/agent-profiles \
  --header 'X-Asteroid-Agents-Api-Key: <api-key>'
{
  "items": [
    {
      "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"
    }
  ],
  "page": 123,
  "pageSize": 123,
  "total": 123
}

Authorizations

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

Query Parameters

​
organizationId
string<uuid>

Filter by organization ID

​
pageSize
integer<int32>
default:50
​
page
integer<int32>
default:1
​
searchName
string

Search profiles by name (partial match)

​
sortField
enum<string>

Available fields for sorting agent profiles

Available options:
name,
created_at,
updated_at
​
sortDirection
enum<string>
Available options:
asc,
desc

Response

The request has succeeded.

​
items
object[]
required
​
page
integer<int64>
required
​
pageSize
integer<int64>
required
​
total
integer<int64>
required