curl --request GET \
--url https://api.heralded.ai/v1/brands/{brand_id}/settings \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.heralded.ai/v1/brands/{brand_id}/settings"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.heralded.ai/v1/brands/{brand_id}/settings', 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://api.heralded.ai/v1/brands/{brand_id}/settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://api.heralded.ai/v1/brands/{brand_id}/settings"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.heralded.ai/v1/brands/{brand_id}/settings")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.heralded.ai/v1/brands/{brand_id}/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"autonomy": {
"areas": [
{
"area": "website",
"outreach": {
"routes": []
},
"refusal": "<string>",
"suspended": true,
"switches": {
"acts_without_asking": true,
"picks_up_work": true,
"runs_steps": true,
"skips_draft_approval": true
},
"unavailable": [
"picks_up_work"
]
}
],
"locked": [
"picks_up_work"
],
"locked_presets": [
"autopilot"
],
"preset": "autopilot",
"read_only": {
"message": "<string>",
"reason": "canceled",
"until": "2023-11-07T05:31:56Z"
},
"simple": {
"ask_before_leaving": true,
"auto_site_fixes": true
},
"site_fixes_executor": true
},
"brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"connections": [
{
"available": true,
"detail": {},
"notification_rules": {},
"provider": "<string>",
"reauthorise_from": "<string>",
"reauthorise_token_ended": true,
"state": "connected"
}
],
"deletion_scheduled_for": "<string>",
"description": "<string>",
"domain": "<string>",
"meta": {
"data_as_of": {
"completed_at": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"query": {}
},
"name": "<string>",
"owned_domains": {
"confirmed": [
"<string>"
],
"derived": [
"<string>"
],
"dismissed": [],
"proposed": [
"<string>"
]
},
"profile": {
"alias_limit": 123,
"aliases": [
{
"name": "<string>",
"removable": true,
"source": "name"
}
],
"claims": [
{
"absent": 123,
"agrees": 123,
"ai_reads": "<string>",
"answers": 123,
"axis": "<string>",
"diverges": 123,
"engines": 123,
"field": "<string>",
"intended": "<string>",
"label": "<string>",
"measured": "<string>",
"partial": 123,
"score": 123
}
],
"countries": {},
"country_languages": {},
"domain": "<string>",
"domain_id": "<string>",
"edited_at": "<string>",
"fact_limit": 20,
"facts": [
{
"added_at": "2023-11-07T05:31:56Z",
"added_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"statement": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"version": 2
}
],
"languages": {},
"personas": [
{
"ai_generated": true,
"audience_type": "<string>",
"description": "<string>",
"fields": {},
"id": "<string>",
"is_general_buyer": true,
"name": "<string>",
"segments": [
{
"id": "<string>",
"is_default": true,
"label": "<string>",
"name": "<string>"
}
],
"shift": "<string>"
}
],
"profile": {
"aliases": [
"<string>"
],
"audience": "<string>",
"category": "<string>",
"country": "<string>",
"differentiators": "<string>",
"language": "<string>",
"measured_product_line": "<string>",
"offering": "<string>",
"product_lines": [
{
"category": "<string>",
"name": "<string>",
"target_buyer": "<string>"
}
]
},
"rival_cap": 123,
"rivals": [
{
"brand_key": "<string>",
"brand_name": "<string>",
"source": "<string>",
"status": "<string>"
}
]
},
"prompts_reserved": 123,
"prompts_used": 123,
"segments": {
"comparison": {
"rows": [
{
"axes": [
{
"axis": "<string>",
"change": {
"delta": 123,
"high": 123,
"low": 123,
"real": true
},
"label": "<string>",
"population": "<string>",
"value": 123
}
],
"chips": {
"claude": false,
"language": "<string>",
"market": "<string>",
"persona": "<string>"
},
"is_default": true,
"label": "<string>",
"name": "<string>",
"prompt_count": 123,
"retired": true,
"score": 123,
"score_change": {
"delta": 123,
"high": 123,
"low": 123,
"real": true
},
"segment_id": "<string>"
}
],
"total": 0
},
"meta": {
"data_as_of": {
"completed_at": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"query": {}
},
"personas": [
{
"ai_generated": true,
"audience_type": "<string>",
"description": "<string>",
"fields": {},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
],
"segment_limit": 123,
"segment_limit_note": "<string>",
"segments": [
{
"config_version": 123,
"country": "<string>",
"engine_selection": [
"<string>"
],
"engine_vocabulary": [
{
"display_name": "<string>",
"engine_id": "<string>",
"sort_order": 123
}
],
"engines": [
"<string>"
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_default": true,
"label": "<string>",
"language": "<string>",
"name": "<string>",
"persona_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prompt_count": 0,
"retired": true,
"subregion": "<string>"
}
],
"vocabulary": {
"languages": {},
"markets": {},
"optional_engines": [
"<string>"
],
"standard_engines": [
"<string>"
],
"subregions": {}
}
}
}{
"code": "invalid_cursor",
"detail": "The cursor is invalid or belongs to a different query.",
"instance": "example-request-id",
"status": 400,
"title": "Bad Request",
"type": "about:blank"
}{
"code": "invalid_token",
"detail": "The Authorization header carries no API key Heralded knows: it is missing, mistyped, revoked or expired.",
"instance": "example-request-id",
"status": 401,
"title": "Unauthorized",
"type": "about:blank"
}{
"code": "not_found",
"detail": "Nothing here that this API key can read.",
"instance": "example-request-id",
"status": 404,
"title": "Not Found",
"type": "about:blank"
}{
"code": "workspace_archived",
"detail": "The API key's organization is archived.",
"instance": "example-request-id",
"status": 409,
"title": "Conflict",
"type": "about:blank"
}{
"code": "invalid_request",
"detail": "The request's parameters are invalid; `errors` names each one.",
"errors": [
{
"loc": [
"query",
"limit"
],
"msg": "Input should be less than or equal to 100",
"type": "less_than_equal"
}
],
"instance": "example-request-id",
"status": 422,
"title": "Unprocessable Content",
"type": "about:blank"
}{
"code": "rate_limited",
"detail": "This caller is past its requests for the minute. Retry after the seconds in Retry-After.",
"instance": "example-request-id",
"rate_limit": {
"limit": 120,
"remaining": 0,
"reset": 60,
"window": 60
},
"status": 429,
"title": "Too Many Requests",
"type": "about:blank"
}Get Brand Settings
Current profile, rivals, owned domains, autonomy, connection status and segments.
curl --request GET \
--url https://api.heralded.ai/v1/brands/{brand_id}/settings \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.heralded.ai/v1/brands/{brand_id}/settings"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.heralded.ai/v1/brands/{brand_id}/settings', 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://api.heralded.ai/v1/brands/{brand_id}/settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://api.heralded.ai/v1/brands/{brand_id}/settings"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.heralded.ai/v1/brands/{brand_id}/settings")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.heralded.ai/v1/brands/{brand_id}/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"autonomy": {
"areas": [
{
"area": "website",
"outreach": {
"routes": []
},
"refusal": "<string>",
"suspended": true,
"switches": {
"acts_without_asking": true,
"picks_up_work": true,
"runs_steps": true,
"skips_draft_approval": true
},
"unavailable": [
"picks_up_work"
]
}
],
"locked": [
"picks_up_work"
],
"locked_presets": [
"autopilot"
],
"preset": "autopilot",
"read_only": {
"message": "<string>",
"reason": "canceled",
"until": "2023-11-07T05:31:56Z"
},
"simple": {
"ask_before_leaving": true,
"auto_site_fixes": true
},
"site_fixes_executor": true
},
"brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"connections": [
{
"available": true,
"detail": {},
"notification_rules": {},
"provider": "<string>",
"reauthorise_from": "<string>",
"reauthorise_token_ended": true,
"state": "connected"
}
],
"deletion_scheduled_for": "<string>",
"description": "<string>",
"domain": "<string>",
"meta": {
"data_as_of": {
"completed_at": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"query": {}
},
"name": "<string>",
"owned_domains": {
"confirmed": [
"<string>"
],
"derived": [
"<string>"
],
"dismissed": [],
"proposed": [
"<string>"
]
},
"profile": {
"alias_limit": 123,
"aliases": [
{
"name": "<string>",
"removable": true,
"source": "name"
}
],
"claims": [
{
"absent": 123,
"agrees": 123,
"ai_reads": "<string>",
"answers": 123,
"axis": "<string>",
"diverges": 123,
"engines": 123,
"field": "<string>",
"intended": "<string>",
"label": "<string>",
"measured": "<string>",
"partial": 123,
"score": 123
}
],
"countries": {},
"country_languages": {},
"domain": "<string>",
"domain_id": "<string>",
"edited_at": "<string>",
"fact_limit": 20,
"facts": [
{
"added_at": "2023-11-07T05:31:56Z",
"added_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"statement": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"version": 2
}
],
"languages": {},
"personas": [
{
"ai_generated": true,
"audience_type": "<string>",
"description": "<string>",
"fields": {},
"id": "<string>",
"is_general_buyer": true,
"name": "<string>",
"segments": [
{
"id": "<string>",
"is_default": true,
"label": "<string>",
"name": "<string>"
}
],
"shift": "<string>"
}
],
"profile": {
"aliases": [
"<string>"
],
"audience": "<string>",
"category": "<string>",
"country": "<string>",
"differentiators": "<string>",
"language": "<string>",
"measured_product_line": "<string>",
"offering": "<string>",
"product_lines": [
{
"category": "<string>",
"name": "<string>",
"target_buyer": "<string>"
}
]
},
"rival_cap": 123,
"rivals": [
{
"brand_key": "<string>",
"brand_name": "<string>",
"source": "<string>",
"status": "<string>"
}
]
},
"prompts_reserved": 123,
"prompts_used": 123,
"segments": {
"comparison": {
"rows": [
{
"axes": [
{
"axis": "<string>",
"change": {
"delta": 123,
"high": 123,
"low": 123,
"real": true
},
"label": "<string>",
"population": "<string>",
"value": 123
}
],
"chips": {
"claude": false,
"language": "<string>",
"market": "<string>",
"persona": "<string>"
},
"is_default": true,
"label": "<string>",
"name": "<string>",
"prompt_count": 123,
"retired": true,
"score": 123,
"score_change": {
"delta": 123,
"high": 123,
"low": 123,
"real": true
},
"segment_id": "<string>"
}
],
"total": 0
},
"meta": {
"data_as_of": {
"completed_at": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"query": {}
},
"personas": [
{
"ai_generated": true,
"audience_type": "<string>",
"description": "<string>",
"fields": {},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
],
"segment_limit": 123,
"segment_limit_note": "<string>",
"segments": [
{
"config_version": 123,
"country": "<string>",
"engine_selection": [
"<string>"
],
"engine_vocabulary": [
{
"display_name": "<string>",
"engine_id": "<string>",
"sort_order": 123
}
],
"engines": [
"<string>"
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_default": true,
"label": "<string>",
"language": "<string>",
"name": "<string>",
"persona_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prompt_count": 0,
"retired": true,
"subregion": "<string>"
}
],
"vocabulary": {
"languages": {},
"markets": {},
"optional_engines": [
"<string>"
],
"standard_engines": [
"<string>"
],
"subregions": {}
}
}
}{
"code": "invalid_cursor",
"detail": "The cursor is invalid or belongs to a different query.",
"instance": "example-request-id",
"status": 400,
"title": "Bad Request",
"type": "about:blank"
}{
"code": "invalid_token",
"detail": "The Authorization header carries no API key Heralded knows: it is missing, mistyped, revoked or expired.",
"instance": "example-request-id",
"status": 401,
"title": "Unauthorized",
"type": "about:blank"
}{
"code": "not_found",
"detail": "Nothing here that this API key can read.",
"instance": "example-request-id",
"status": 404,
"title": "Not Found",
"type": "about:blank"
}{
"code": "workspace_archived",
"detail": "The API key's organization is archived.",
"instance": "example-request-id",
"status": 409,
"title": "Conflict",
"type": "about:blank"
}{
"code": "invalid_request",
"detail": "The request's parameters are invalid; `errors` names each one.",
"errors": [
{
"loc": [
"query",
"limit"
],
"msg": "Input should be less than or equal to 100",
"type": "less_than_equal"
}
],
"instance": "example-request-id",
"status": 422,
"title": "Unprocessable Content",
"type": "about:blank"
}{
"code": "rate_limited",
"detail": "This caller is past its requests for the minute. Retry after the seconds in Retry-After.",
"instance": "example-request-id",
"rate_limit": {
"limit": 120,
"remaining": 0,
"reset": 60,
"window": 60
},
"status": 429,
"title": "Too Many Requests",
"type": "about:blank"
}Authorizations
An API key, sent as Authorization: Bearer hrld_....
Path Parameters
Response
Successful Response
A brand's Autonomy as the page draws it: the two switches, the preset, the 3 x 4 grid, and what the plan locks.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Normalized query and newest included scan.
Show child attributes
Show child attributes
The review gate over which domains count as this brand's own.
Show child attributes
Show child attributes
The configuration page, whole. No band and no score: nothing here is a measurement, and everything here decides one.
Show child attributes
Show child attributes
The brand's current prompt reservation; null when it shares the pool.
Active prompts in the current prompt set, excluding retired segments. A paused brand keeps this count while spending no organization slots.
Show child attributes
Show child attributes