List Agent Profiles

List all agent profiles for an organization

GET /agent-profiles

List Agent Profiles

cURL

curl --request GET \
  --url https://odyssey.asteroid.ai/agents/v2/agent-profiles \
  --header 'X-Asteroid-Agents-Api-Key: <api-key>'

import requests

url = "https://odyssey.asteroid.ai/agents/v2/agent-profiles"

headers = {"X-Asteroid-Agents-Api-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-Asteroid-Agents-Api-Key': '<api-key>'}};

fetch('https://odyssey.asteroid.ai/agents/v2/agent-profiles', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://odyssey.asteroid.ai/agents/v2/agent-profiles",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Asteroid-Agents-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://odyssey.asteroid.ai/agents/v2/agent-profiles"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Asteroid-Agents-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://odyssey.asteroid.ai/agents/v2/agent-profiles")
  .header("X-Asteroid-Agents-Api-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://odyssey.asteroid.ai/agents/v2/agent-profiles")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Asteroid-Agents-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "items": [
    {
      "adblockActive": true,
      "allow3rdCookies": true,
      "cachePersistence": true,
      "captchaSolverActive": true,
      "cookies": [
        {
          "domain": "<string>",
          "httpOnly": true,
          "key": "<string>",
          "name": "<string>",
          "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>",
      "extensionIds": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "extraStealth": true,
      "forcePopupsAsTabsActive": true,
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "inboxEmail": "<string>",
      "mediaBlockerActive": true,
      "name": "<string>",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "pdfViewerActive": true,
      "popupBlockerActive": true,
      "stickyIP": true,
      "tracingEnabled": true,
      "updatedAt": "2023-11-07T05:31:56Z",
      "customProxy": {
        "server": "<string>",
        "username": "<string>"
      },
      "inboxEmailPrefix": "<string>",
      "proxyGatewayPresetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "proxyType": "basic"
    }
  ],
  "page": 123,
  "pageSize": 123,
  "total": 123
}

{
  "code": 400,
  "message": "<string>"
}

{
  "code": 401,
  "message": "<string>"
}

{
  "code": 403,
  "message": "<string>"
}

{
  "code": 404,
  "message": "<string>"
}

{
  "code": 500,
  "message": "<string>"
}

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

200

application/json

The request has succeeded.

items · object[] · required

Show child attributes

page · integer<int64> · required

pageSize · integer<int64> · required

total · integer<int64> · required