Create Profile
curl --request POST \
--url https://odyssey.asteroid.ai/agents/v2/profiles \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"description": "<string>",
"name": "<string>",
"adblockActive": false,
"allow3rdCookies": false,
"cachePersistence": false,
"captchaSolverActive": false,
"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"
}
],
"credentials": [
{
"data": "<string>",
"name": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"extensionIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"extraStealth": false,
"fingerprintId": "<string>",
"forcePopupsAsTabsActive": true,
"inboxEmailPrefix": "<string>",
"mediaBlockerActive": false,
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pdfViewerActive": false,
"popupBlockerActive": false,
"proxyGatewayPresetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"proxyMode": "none",
"proxyType": "basic",
"secretIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"stickyIP": false,
"tracingEnabled": true,
"vaultItemIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
'import requests
url = "https://odyssey.asteroid.ai/agents/v2/profiles"
payload = {
"description": "<string>",
"name": "<string>",
"adblockActive": False,
"allow3rdCookies": False,
"cachePersistence": False,
"captchaSolverActive": False,
"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"
}
],
"credentials": [
{
"data": "<string>",
"name": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"extensionIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"extraStealth": False,
"fingerprintId": "<string>",
"forcePopupsAsTabsActive": True,
"inboxEmailPrefix": "<string>",
"mediaBlockerActive": False,
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pdfViewerActive": False,
"popupBlockerActive": False,
"proxyGatewayPresetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"proxyMode": "none",
"proxyType": "basic",
"secretIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"stickyIP": False,
"tracingEnabled": True,
"vaultItemIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
description: '<string>',
name: '<string>',
adblockActive: false,
allow3rdCookies: false,
cachePersistence: false,
captchaSolverActive: false,
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'
}
],
credentials: [
{
data: '<string>',
name: '<string>',
createdAt: '2023-11-07T05:31:56Z',
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
}
],
extensionIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
extraStealth: false,
fingerprintId: '<string>',
forcePopupsAsTabsActive: true,
inboxEmailPrefix: '<string>',
mediaBlockerActive: false,
organizationId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
pdfViewerActive: false,
popupBlockerActive: false,
proxyGatewayPresetId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
proxyMode: 'none',
proxyType: 'basic',
secretIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
stickyIP: false,
tracingEnabled: true,
vaultItemIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
})
};
fetch('https://odyssey.asteroid.ai/agents/v2/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/profiles",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'description' => '<string>',
'name' => '<string>',
'adblockActive' => false,
'allow3rdCookies' => false,
'cachePersistence' => false,
'captchaSolverActive' => false,
'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'
]
],
'credentials' => [
[
'data' => '<string>',
'name' => '<string>',
'createdAt' => '2023-11-07T05:31:56Z',
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'extensionIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'extraStealth' => false,
'fingerprintId' => '<string>',
'forcePopupsAsTabsActive' => true,
'inboxEmailPrefix' => '<string>',
'mediaBlockerActive' => false,
'organizationId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'pdfViewerActive' => false,
'popupBlockerActive' => false,
'proxyGatewayPresetId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'proxyMode' => 'none',
'proxyType' => 'basic',
'secretIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'stickyIP' => false,
'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/profiles"
payload := strings.NewReader("{\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"adblockActive\": false,\n \"allow3rdCookies\": false,\n \"cachePersistence\": false,\n \"captchaSolverActive\": false,\n \"cookies\": [\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 \"credentials\": [\n {\n \"data\": \"<string>\",\n \"name\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"extensionIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"extraStealth\": false,\n \"fingerprintId\": \"<string>\",\n \"forcePopupsAsTabsActive\": true,\n \"inboxEmailPrefix\": \"<string>\",\n \"mediaBlockerActive\": false,\n \"organizationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"pdfViewerActive\": false,\n \"popupBlockerActive\": false,\n \"proxyGatewayPresetId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"proxyMode\": \"none\",\n \"proxyType\": \"basic\",\n \"secretIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"stickyIP\": false,\n \"tracingEnabled\": true,\n \"vaultItemIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://odyssey.asteroid.ai/agents/v2/profiles")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"adblockActive\": false,\n \"allow3rdCookies\": false,\n \"cachePersistence\": false,\n \"captchaSolverActive\": false,\n \"cookies\": [\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 \"credentials\": [\n {\n \"data\": \"<string>\",\n \"name\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"extensionIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"extraStealth\": false,\n \"fingerprintId\": \"<string>\",\n \"forcePopupsAsTabsActive\": true,\n \"inboxEmailPrefix\": \"<string>\",\n \"mediaBlockerActive\": false,\n \"organizationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"pdfViewerActive\": false,\n \"popupBlockerActive\": false,\n \"proxyGatewayPresetId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"proxyMode\": \"none\",\n \"proxyType\": \"basic\",\n \"secretIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"stickyIP\": false,\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/profiles")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"adblockActive\": false,\n \"allow3rdCookies\": false,\n \"cachePersistence\": false,\n \"captchaSolverActive\": false,\n \"cookies\": [\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 \"credentials\": [\n {\n \"data\": \"<string>\",\n \"name\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"extensionIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"extraStealth\": false,\n \"fingerprintId\": \"<string>\",\n \"forcePopupsAsTabsActive\": true,\n \"inboxEmailPrefix\": \"<string>\",\n \"mediaBlockerActive\": false,\n \"organizationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"pdfViewerActive\": false,\n \"popupBlockerActive\": false,\n \"proxyGatewayPresetId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"proxyMode\": \"none\",\n \"proxyType\": \"basic\",\n \"secretIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"stickyIP\": false,\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>",
"detail": "<string>",
"errors": [
{
"detail": "<string>",
"parameter": "<string>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>"
}{
"code": 401,
"message": "<string>",
"detail": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>"
}{
"code": 403,
"message": "<string>",
"capability": "<string>",
"detail": "<string>",
"instance": "<string>",
"reason": "capability_required",
"status": 123,
"title": "<string>",
"type": "<string>"
}{
"code": 404,
"message": "<string>",
"detail": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>"
}{
"code": 409,
"message": "<string>",
"detail": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>"
}{
"code": 500,
"message": "<string>",
"detail": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>"
}Profiles
Create Profile
Create a new profile. 409 when two attached secrets share a key.
POST
/
agents
/
v2
/
profiles
Create Profile
curl --request POST \
--url https://odyssey.asteroid.ai/agents/v2/profiles \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"description": "<string>",
"name": "<string>",
"adblockActive": false,
"allow3rdCookies": false,
"cachePersistence": false,
"captchaSolverActive": false,
"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"
}
],
"credentials": [
{
"data": "<string>",
"name": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"extensionIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"extraStealth": false,
"fingerprintId": "<string>",
"forcePopupsAsTabsActive": true,
"inboxEmailPrefix": "<string>",
"mediaBlockerActive": false,
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pdfViewerActive": false,
"popupBlockerActive": false,
"proxyGatewayPresetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"proxyMode": "none",
"proxyType": "basic",
"secretIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"stickyIP": false,
"tracingEnabled": true,
"vaultItemIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
'import requests
url = "https://odyssey.asteroid.ai/agents/v2/profiles"
payload = {
"description": "<string>",
"name": "<string>",
"adblockActive": False,
"allow3rdCookies": False,
"cachePersistence": False,
"captchaSolverActive": False,
"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"
}
],
"credentials": [
{
"data": "<string>",
"name": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"extensionIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"extraStealth": False,
"fingerprintId": "<string>",
"forcePopupsAsTabsActive": True,
"inboxEmailPrefix": "<string>",
"mediaBlockerActive": False,
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pdfViewerActive": False,
"popupBlockerActive": False,
"proxyGatewayPresetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"proxyMode": "none",
"proxyType": "basic",
"secretIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"stickyIP": False,
"tracingEnabled": True,
"vaultItemIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
description: '<string>',
name: '<string>',
adblockActive: false,
allow3rdCookies: false,
cachePersistence: false,
captchaSolverActive: false,
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'
}
],
credentials: [
{
data: '<string>',
name: '<string>',
createdAt: '2023-11-07T05:31:56Z',
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
}
],
extensionIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
extraStealth: false,
fingerprintId: '<string>',
forcePopupsAsTabsActive: true,
inboxEmailPrefix: '<string>',
mediaBlockerActive: false,
organizationId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
pdfViewerActive: false,
popupBlockerActive: false,
proxyGatewayPresetId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
proxyMode: 'none',
proxyType: 'basic',
secretIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
stickyIP: false,
tracingEnabled: true,
vaultItemIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
})
};
fetch('https://odyssey.asteroid.ai/agents/v2/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/profiles",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'description' => '<string>',
'name' => '<string>',
'adblockActive' => false,
'allow3rdCookies' => false,
'cachePersistence' => false,
'captchaSolverActive' => false,
'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'
]
],
'credentials' => [
[
'data' => '<string>',
'name' => '<string>',
'createdAt' => '2023-11-07T05:31:56Z',
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'extensionIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'extraStealth' => false,
'fingerprintId' => '<string>',
'forcePopupsAsTabsActive' => true,
'inboxEmailPrefix' => '<string>',
'mediaBlockerActive' => false,
'organizationId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'pdfViewerActive' => false,
'popupBlockerActive' => false,
'proxyGatewayPresetId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'proxyMode' => 'none',
'proxyType' => 'basic',
'secretIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'stickyIP' => false,
'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/profiles"
payload := strings.NewReader("{\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"adblockActive\": false,\n \"allow3rdCookies\": false,\n \"cachePersistence\": false,\n \"captchaSolverActive\": false,\n \"cookies\": [\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 \"credentials\": [\n {\n \"data\": \"<string>\",\n \"name\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"extensionIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"extraStealth\": false,\n \"fingerprintId\": \"<string>\",\n \"forcePopupsAsTabsActive\": true,\n \"inboxEmailPrefix\": \"<string>\",\n \"mediaBlockerActive\": false,\n \"organizationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"pdfViewerActive\": false,\n \"popupBlockerActive\": false,\n \"proxyGatewayPresetId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"proxyMode\": \"none\",\n \"proxyType\": \"basic\",\n \"secretIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"stickyIP\": false,\n \"tracingEnabled\": true,\n \"vaultItemIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://odyssey.asteroid.ai/agents/v2/profiles")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"adblockActive\": false,\n \"allow3rdCookies\": false,\n \"cachePersistence\": false,\n \"captchaSolverActive\": false,\n \"cookies\": [\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 \"credentials\": [\n {\n \"data\": \"<string>\",\n \"name\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"extensionIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"extraStealth\": false,\n \"fingerprintId\": \"<string>\",\n \"forcePopupsAsTabsActive\": true,\n \"inboxEmailPrefix\": \"<string>\",\n \"mediaBlockerActive\": false,\n \"organizationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"pdfViewerActive\": false,\n \"popupBlockerActive\": false,\n \"proxyGatewayPresetId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"proxyMode\": \"none\",\n \"proxyType\": \"basic\",\n \"secretIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"stickyIP\": false,\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/profiles")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"adblockActive\": false,\n \"allow3rdCookies\": false,\n \"cachePersistence\": false,\n \"captchaSolverActive\": false,\n \"cookies\": [\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 \"credentials\": [\n {\n \"data\": \"<string>\",\n \"name\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"extensionIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"extraStealth\": false,\n \"fingerprintId\": \"<string>\",\n \"forcePopupsAsTabsActive\": true,\n \"inboxEmailPrefix\": \"<string>\",\n \"mediaBlockerActive\": false,\n \"organizationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"pdfViewerActive\": false,\n \"popupBlockerActive\": false,\n \"proxyGatewayPresetId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"proxyMode\": \"none\",\n \"proxyType\": \"basic\",\n \"secretIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"stickyIP\": false,\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>",
"detail": "<string>",
"errors": [
{
"detail": "<string>",
"parameter": "<string>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>"
}{
"code": 401,
"message": "<string>",
"detail": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>"
}{
"code": 403,
"message": "<string>",
"capability": "<string>",
"detail": "<string>",
"instance": "<string>",
"reason": "capability_required",
"status": 123,
"title": "<string>",
"type": "<string>"
}{
"code": 404,
"message": "<string>",
"detail": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>"
}{
"code": 409,
"message": "<string>",
"detail": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>"
}{
"code": 500,
"message": "<string>",
"detail": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>"
}Authorizations
Body
application/json
Request to create a new agent profile
Maximum string length:
1000Name of the agent profile (must be unique within organization)
Required string length:
1 - 255Whether to allow third-party cookies
Whether to persist browser cache between sessions
Whether the captcha solver should be active (managed proxy only)
Show child attributes
Show child attributes
Deprecated: use secretIds. Initial credentials to create with the profile.
Show child attributes
Show child attributes
Custom proxy configuration (required for custom proxy mode)
Show child attributes
Show child attributes
Stable org extension IDs to attach to this profile
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. Empty or null means unset.
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.)
Operating system to emulate in the browser
Available options:
macos, windows The ID of the organization that the profile belongs to. Defaults to the one organization the caller acts in, such as an API key's. Required when the caller belongs to several.
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 (required for gateway proxy mode)
Proxy configuration mode
Available options:
none, managed, custom, gateway Type of managed proxy to use (required for managed proxy mode)
Available options:
basic Secret IDs to attach to this profile. Do not set together with vaultItemIds.
Whether to use the same IP address for all executions (managed proxy only)
Whether browser tracing is enabled (admin only, defaults to true)
Deprecated: use secretIds. Org vault item IDs attached to this profile.
Response
The request has succeeded and a new resource has been created as a result.
An agent profile containing browser configuration and credentials
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)
Show child attributes
Show child attributes
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
Stable org extension IDs attached to this profile
Whether to force popups to open as tabs
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)
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 in the browser
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