Update Agent Profile
curl --request PATCH \
--url https://odyssey.asteroid.ai/agents/v2/agent-profiles/{profileId} \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"adblockActive": true,
"allow3rdCookies": true,
"cachePersistence": true,
"captchaSolverActive": true,
"cookiesToAdd": [
{
"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"
}
],
"cookiesToDelete": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"credentialsToAdd": [
{
"data": "<string>",
"name": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"credentialsToDelete": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"credentialsToUpdate": [
{
"data": "<string>",
"name": "<string>"
}
],
"description": "<string>",
"extensionIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"extraStealth": true,
"fingerprintId": "<string>",
"forcePopupsAsTabsActive": true,
"inboxEmailPrefix": "<string>",
"mediaBlockerActive": true,
"name": "<string>",
"pdfViewerActive": true,
"popupBlockerActive": true,
"proxyGatewayPresetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"proxyType": "basic",
"tracingEnabled": true,
"vaultItemIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
'import requests
url = "https://odyssey.asteroid.ai/agents/v2/agent-profiles/{profileId}"
payload = {
"adblockActive": True,
"allow3rdCookies": True,
"cachePersistence": True,
"captchaSolverActive": True,
"cookiesToAdd": [
{
"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"
}
],
"cookiesToDelete": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"credentialsToAdd": [
{
"data": "<string>",
"name": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"credentialsToDelete": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"credentialsToUpdate": [
{
"data": "<string>",
"name": "<string>"
}
],
"description": "<string>",
"extensionIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"extraStealth": True,
"fingerprintId": "<string>",
"forcePopupsAsTabsActive": True,
"inboxEmailPrefix": "<string>",
"mediaBlockerActive": True,
"name": "<string>",
"pdfViewerActive": True,
"popupBlockerActive": True,
"proxyGatewayPresetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"proxyType": "basic",
"tracingEnabled": True,
"vaultItemIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
adblockActive: true,
allow3rdCookies: true,
cachePersistence: true,
captchaSolverActive: true,
cookiesToAdd: [
{
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'
}
],
cookiesToDelete: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
credentialsToAdd: [
{
data: '<string>',
name: '<string>',
createdAt: '2023-11-07T05:31:56Z',
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
}
],
credentialsToDelete: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
credentialsToUpdate: [{data: '<string>', name: '<string>'}],
description: '<string>',
extensionIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
extraStealth: true,
fingerprintId: '<string>',
forcePopupsAsTabsActive: true,
inboxEmailPrefix: '<string>',
mediaBlockerActive: true,
name: '<string>',
pdfViewerActive: true,
popupBlockerActive: true,
proxyGatewayPresetId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
proxyType: 'basic',
tracingEnabled: true,
vaultItemIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
})
};
fetch('https://odyssey.asteroid.ai/agents/v2/agent-profiles/{profileId}', 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/{profileId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'adblockActive' => true,
'allow3rdCookies' => true,
'cachePersistence' => true,
'captchaSolverActive' => true,
'cookiesToAdd' => [
[
'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'
]
],
'cookiesToDelete' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'credentialsToAdd' => [
[
'data' => '<string>',
'name' => '<string>',
'createdAt' => '2023-11-07T05:31:56Z',
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'credentialsToDelete' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'credentialsToUpdate' => [
[
'data' => '<string>',
'name' => '<string>'
]
],
'description' => '<string>',
'extensionIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'extraStealth' => true,
'fingerprintId' => '<string>',
'forcePopupsAsTabsActive' => true,
'inboxEmailPrefix' => '<string>',
'mediaBlockerActive' => true,
'name' => '<string>',
'pdfViewerActive' => true,
'popupBlockerActive' => true,
'proxyGatewayPresetId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'proxyType' => 'basic',
'tracingEnabled' => true,
'vaultItemIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://odyssey.asteroid.ai/agents/v2/agent-profiles/{profileId}"
payload := strings.NewReader("{\n \"adblockActive\": true,\n \"allow3rdCookies\": true,\n \"cachePersistence\": true,\n \"captchaSolverActive\": true,\n \"cookiesToAdd\": [\n {\n \"domain\": \"<string>\",\n \"httpOnly\": true,\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"secure\": true,\n \"value\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"expiry\": \"2023-11-07T05:31:56Z\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"cookiesToDelete\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"credentialsToAdd\": [\n {\n \"data\": \"<string>\",\n \"name\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"credentialsToDelete\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"credentialsToUpdate\": [\n {\n \"data\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"extensionIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"extraStealth\": true,\n \"fingerprintId\": \"<string>\",\n \"forcePopupsAsTabsActive\": true,\n \"inboxEmailPrefix\": \"<string>\",\n \"mediaBlockerActive\": true,\n \"name\": \"<string>\",\n \"pdfViewerActive\": true,\n \"popupBlockerActive\": true,\n \"proxyGatewayPresetId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"proxyType\": \"basic\",\n \"tracingEnabled\": true,\n \"vaultItemIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://odyssey.asteroid.ai/agents/v2/agent-profiles/{profileId}")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"adblockActive\": true,\n \"allow3rdCookies\": true,\n \"cachePersistence\": true,\n \"captchaSolverActive\": true,\n \"cookiesToAdd\": [\n {\n \"domain\": \"<string>\",\n \"httpOnly\": true,\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"secure\": true,\n \"value\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"expiry\": \"2023-11-07T05:31:56Z\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"cookiesToDelete\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"credentialsToAdd\": [\n {\n \"data\": \"<string>\",\n \"name\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"credentialsToDelete\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"credentialsToUpdate\": [\n {\n \"data\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"extensionIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"extraStealth\": true,\n \"fingerprintId\": \"<string>\",\n \"forcePopupsAsTabsActive\": true,\n \"inboxEmailPrefix\": \"<string>\",\n \"mediaBlockerActive\": true,\n \"name\": \"<string>\",\n \"pdfViewerActive\": true,\n \"popupBlockerActive\": true,\n \"proxyGatewayPresetId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"proxyType\": \"basic\",\n \"tracingEnabled\": true,\n \"vaultItemIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://odyssey.asteroid.ai/agents/v2/agent-profiles/{profileId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"adblockActive\": true,\n \"allow3rdCookies\": true,\n \"cachePersistence\": true,\n \"captchaSolverActive\": true,\n \"cookiesToAdd\": [\n {\n \"domain\": \"<string>\",\n \"httpOnly\": true,\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"secure\": true,\n \"value\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"expiry\": \"2023-11-07T05:31:56Z\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"cookiesToDelete\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"credentialsToAdd\": [\n {\n \"data\": \"<string>\",\n \"name\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"credentialsToDelete\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"credentialsToUpdate\": [\n {\n \"data\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"extensionIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"extraStealth\": true,\n \"fingerprintId\": \"<string>\",\n \"forcePopupsAsTabsActive\": true,\n \"inboxEmailPrefix\": \"<string>\",\n \"mediaBlockerActive\": true,\n \"name\": \"<string>\",\n \"pdfViewerActive\": true,\n \"popupBlockerActive\": true,\n \"proxyGatewayPresetId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"proxyType\": \"basic\",\n \"tracingEnabled\": true,\n \"vaultItemIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"adblockActive": true,
"allow3rdCookies": 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>",
"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,
"proxyMode": "none",
"stickyIP": true,
"tracingEnabled": true,
"updatedAt": "2023-11-07T05:31:56Z",
"vaultItems": [
{
"fields": [
{
"key": "<string>",
"placeholder": "<string>",
"type": "username",
"legacyPlaceholder": "<string>"
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"itemKey": "<string>",
"kind": "login",
"name": "<string>"
}
],
"customProxy": {
"server": "<string>",
"username": "<string>"
},
"fingerprintId": "<string>",
"inboxEmailPrefix": "<string>",
"operatingSystem": "macos",
"proxyCC": "us",
"proxyGatewayPresetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"proxyType": "basic"
}{
"code": 400,
"message": "<string>"
}{
"code": 401,
"message": "<string>"
}{
"code": 403,
"message": "<string>"
}{
"code": 404,
"message": "<string>"
}{
"code": 409,
"message": "<string>"
}{
"code": 500,
"message": "<string>"
}Agent Profiles
Update Agent Profile
Update an existing agent profile. 409 when two attached vault items share a key.
PATCH
/
agent-profiles
/
{profileId}
Update Agent Profile
curl --request PATCH \
--url https://odyssey.asteroid.ai/agents/v2/agent-profiles/{profileId} \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"adblockActive": true,
"allow3rdCookies": true,
"cachePersistence": true,
"captchaSolverActive": true,
"cookiesToAdd": [
{
"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"
}
],
"cookiesToDelete": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"credentialsToAdd": [
{
"data": "<string>",
"name": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"credentialsToDelete": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"credentialsToUpdate": [
{
"data": "<string>",
"name": "<string>"
}
],
"description": "<string>",
"extensionIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"extraStealth": true,
"fingerprintId": "<string>",
"forcePopupsAsTabsActive": true,
"inboxEmailPrefix": "<string>",
"mediaBlockerActive": true,
"name": "<string>",
"pdfViewerActive": true,
"popupBlockerActive": true,
"proxyGatewayPresetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"proxyType": "basic",
"tracingEnabled": true,
"vaultItemIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
'import requests
url = "https://odyssey.asteroid.ai/agents/v2/agent-profiles/{profileId}"
payload = {
"adblockActive": True,
"allow3rdCookies": True,
"cachePersistence": True,
"captchaSolverActive": True,
"cookiesToAdd": [
{
"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"
}
],
"cookiesToDelete": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"credentialsToAdd": [
{
"data": "<string>",
"name": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"credentialsToDelete": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"credentialsToUpdate": [
{
"data": "<string>",
"name": "<string>"
}
],
"description": "<string>",
"extensionIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"extraStealth": True,
"fingerprintId": "<string>",
"forcePopupsAsTabsActive": True,
"inboxEmailPrefix": "<string>",
"mediaBlockerActive": True,
"name": "<string>",
"pdfViewerActive": True,
"popupBlockerActive": True,
"proxyGatewayPresetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"proxyType": "basic",
"tracingEnabled": True,
"vaultItemIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
adblockActive: true,
allow3rdCookies: true,
cachePersistence: true,
captchaSolverActive: true,
cookiesToAdd: [
{
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'
}
],
cookiesToDelete: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
credentialsToAdd: [
{
data: '<string>',
name: '<string>',
createdAt: '2023-11-07T05:31:56Z',
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
}
],
credentialsToDelete: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
credentialsToUpdate: [{data: '<string>', name: '<string>'}],
description: '<string>',
extensionIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
extraStealth: true,
fingerprintId: '<string>',
forcePopupsAsTabsActive: true,
inboxEmailPrefix: '<string>',
mediaBlockerActive: true,
name: '<string>',
pdfViewerActive: true,
popupBlockerActive: true,
proxyGatewayPresetId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
proxyType: 'basic',
tracingEnabled: true,
vaultItemIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
})
};
fetch('https://odyssey.asteroid.ai/agents/v2/agent-profiles/{profileId}', 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/{profileId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'adblockActive' => true,
'allow3rdCookies' => true,
'cachePersistence' => true,
'captchaSolverActive' => true,
'cookiesToAdd' => [
[
'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'
]
],
'cookiesToDelete' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'credentialsToAdd' => [
[
'data' => '<string>',
'name' => '<string>',
'createdAt' => '2023-11-07T05:31:56Z',
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'credentialsToDelete' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'credentialsToUpdate' => [
[
'data' => '<string>',
'name' => '<string>'
]
],
'description' => '<string>',
'extensionIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'extraStealth' => true,
'fingerprintId' => '<string>',
'forcePopupsAsTabsActive' => true,
'inboxEmailPrefix' => '<string>',
'mediaBlockerActive' => true,
'name' => '<string>',
'pdfViewerActive' => true,
'popupBlockerActive' => true,
'proxyGatewayPresetId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'proxyType' => 'basic',
'tracingEnabled' => true,
'vaultItemIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://odyssey.asteroid.ai/agents/v2/agent-profiles/{profileId}"
payload := strings.NewReader("{\n \"adblockActive\": true,\n \"allow3rdCookies\": true,\n \"cachePersistence\": true,\n \"captchaSolverActive\": true,\n \"cookiesToAdd\": [\n {\n \"domain\": \"<string>\",\n \"httpOnly\": true,\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"secure\": true,\n \"value\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"expiry\": \"2023-11-07T05:31:56Z\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"cookiesToDelete\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"credentialsToAdd\": [\n {\n \"data\": \"<string>\",\n \"name\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"credentialsToDelete\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"credentialsToUpdate\": [\n {\n \"data\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"extensionIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"extraStealth\": true,\n \"fingerprintId\": \"<string>\",\n \"forcePopupsAsTabsActive\": true,\n \"inboxEmailPrefix\": \"<string>\",\n \"mediaBlockerActive\": true,\n \"name\": \"<string>\",\n \"pdfViewerActive\": true,\n \"popupBlockerActive\": true,\n \"proxyGatewayPresetId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"proxyType\": \"basic\",\n \"tracingEnabled\": true,\n \"vaultItemIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://odyssey.asteroid.ai/agents/v2/agent-profiles/{profileId}")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"adblockActive\": true,\n \"allow3rdCookies\": true,\n \"cachePersistence\": true,\n \"captchaSolverActive\": true,\n \"cookiesToAdd\": [\n {\n \"domain\": \"<string>\",\n \"httpOnly\": true,\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"secure\": true,\n \"value\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"expiry\": \"2023-11-07T05:31:56Z\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"cookiesToDelete\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"credentialsToAdd\": [\n {\n \"data\": \"<string>\",\n \"name\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"credentialsToDelete\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"credentialsToUpdate\": [\n {\n \"data\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"extensionIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"extraStealth\": true,\n \"fingerprintId\": \"<string>\",\n \"forcePopupsAsTabsActive\": true,\n \"inboxEmailPrefix\": \"<string>\",\n \"mediaBlockerActive\": true,\n \"name\": \"<string>\",\n \"pdfViewerActive\": true,\n \"popupBlockerActive\": true,\n \"proxyGatewayPresetId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"proxyType\": \"basic\",\n \"tracingEnabled\": true,\n \"vaultItemIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://odyssey.asteroid.ai/agents/v2/agent-profiles/{profileId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"adblockActive\": true,\n \"allow3rdCookies\": true,\n \"cachePersistence\": true,\n \"captchaSolverActive\": true,\n \"cookiesToAdd\": [\n {\n \"domain\": \"<string>\",\n \"httpOnly\": true,\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"secure\": true,\n \"value\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"expiry\": \"2023-11-07T05:31:56Z\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"cookiesToDelete\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"credentialsToAdd\": [\n {\n \"data\": \"<string>\",\n \"name\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"credentialsToDelete\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"credentialsToUpdate\": [\n {\n \"data\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"extensionIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"extraStealth\": true,\n \"fingerprintId\": \"<string>\",\n \"forcePopupsAsTabsActive\": true,\n \"inboxEmailPrefix\": \"<string>\",\n \"mediaBlockerActive\": true,\n \"name\": \"<string>\",\n \"pdfViewerActive\": true,\n \"popupBlockerActive\": true,\n \"proxyGatewayPresetId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"proxyType\": \"basic\",\n \"tracingEnabled\": true,\n \"vaultItemIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"adblockActive": true,
"allow3rdCookies": 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>",
"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,
"proxyMode": "none",
"stickyIP": true,
"tracingEnabled": true,
"updatedAt": "2023-11-07T05:31:56Z",
"vaultItems": [
{
"fields": [
{
"key": "<string>",
"placeholder": "<string>",
"type": "username",
"legacyPlaceholder": "<string>"
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"itemKey": "<string>",
"kind": "login",
"name": "<string>"
}
],
"customProxy": {
"server": "<string>",
"username": "<string>"
},
"fingerprintId": "<string>",
"inboxEmailPrefix": "<string>",
"operatingSystem": "macos",
"proxyCC": "us",
"proxyGatewayPresetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"proxyType": "basic"
}{
"code": 400,
"message": "<string>"
}{
"code": 401,
"message": "<string>"
}{
"code": 403,
"message": "<string>"
}{
"code": 404,
"message": "<string>"
}{
"code": 409,
"message": "<string>"
}{
"code": 500,
"message": "<string>"
}Authorizations
Path Parameters
The ID of the agent profile
Body
application/json
Fields to update
Request to update an existing agent profile
Whether to enable ad blocking
Whether to allow third-party cookies
Whether to persist browser cache between sessions
Whether the captcha solver should be active (managed proxy only)
Cookies to add to the profile
Show child attributes
Show child attributes
IDs of cookies to remove from the profile
Deprecated: Use vaultItemIds instead. Credentials to add to the profile.
Show child attributes
Show child attributes
Deprecated: Use vaultItemIds instead. IDs of credentials to remove from the profile.
Deprecated: Use vaultItemIds instead. Credentials to update by name (matched case-insensitively).
Show child attributes
Show child attributes
Custom proxy configuration (for custom proxy mode)
Show child attributes
Show child attributes
New description for the profile
Maximum string length:
1000Stable org extension IDs to attach to this profile
Whether to enable extra stealth mode
Anchor browser fingerprint ID to apply at session create (admin only). Ignored unless the browser runs with extra stealth and an active proxy without sticky IP, usually set on the custom environment. An empty string clears it; omit to leave unchanged. Null is rejected — the generated servers cannot tell null from an omitted field, so accepting it would turn an intended clear into a silent no-op.
Pattern:
^([a-fA-F0-9]{24})?$Whether to force popups to open as tabs
Optional custom prefix for the agent's inbox email address. If set, the inbox will be {prefix}@agentmail.asteroid.ai.
Whether to enable media blocking (images, videos, etc.)
New name for the profile
Required string length:
1 - 255Operating system to emulate
Available options:
macos, windows Whether to enable the built-in PDF viewer (if disabled, PDFs are downloaded)
Whether to enable popup blocking (requires adblock to be active)
Country code for proxy location (for managed proxy mode)
Available options:
us, uk, fr, it, jp, au, de, fi, ca Proxy gateway preset ID (for gateway proxy mode)
Proxy configuration mode
Available options:
none, managed, custom, gateway Type of managed proxy to use (for managed proxy mode)
Available options:
basic Whether browser tracing is enabled (admin only)
Org vault item IDs attached to this profile.
Response
The request has succeeded.
An agent profile containing browser configuration and credentials
Whether to enable ad blocking
Whether to allow third-party cookies
Whether to persist browser cache between sessions
Whether the captcha solver is active for this profile (managed proxy only)
List of cookies associated with this profile
Show child attributes
Show child attributes
When the profile was created
Deprecated: Use vaultItems instead. Legacy credential names mirrored from attached vault items (legacyName). Prefer vaultItems; ##NAME## remains a grace-period alias.
Show child attributes
Show child attributes
Description of the agent profile
Stable org extension IDs attached to this profile
Whether extra stealth mode is enabled
Whether to force popups to open as tabs
Unique identifier for the agent profile
The resolved inbox email address for this profile
Whether to enable media blocking (images, videos, etc.)
Name of the agent profile (unique within organization)
The ID of the organization that owns this profile
Whether to enable the built-in PDF viewer (if disabled, PDFs are downloaded)
Whether to enable popup blocking (requires adblock to be active)
Proxy configuration mode
Available options:
none, managed, custom, gateway Whether to use the same IP address for all executions (managed proxy only)
Whether browser tracing is enabled (admin only)
When the profile was last updated
Org vault items attached to this profile. Deleted items are omitted.
Show child attributes
Show child attributes
Custom proxy configuration (for custom proxy mode, password excluded)
Show child attributes
Show child attributes
Anchor browser fingerprint ID applied at session create (admin only). Absent or null when unset.
Optional custom prefix for the agent's inbox email address. If set, the inbox will be {prefix}@agentmail.asteroid.ai. If not set, defaults to the first 8 characters of the profile ID.
Operating system to emulate
Available options:
macos, windows Country code for proxy location (for managed proxy mode)
Available options:
us, uk, fr, it, jp, au, de, fi, ca Proxy gateway preset ID (for gateway proxy mode)
Type of managed proxy to use (for managed proxy mode)
Available options:
basic