Get Brand Settings
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": [
{
"activity": [
{
"at": "2023-11-07T05:31:56Z",
"kind": "<string>",
"label": "<string>"
}
],
"available": true,
"binding_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"connect_another": false,
"detail": {},
"instances": [
{
"access": "personal",
"account": "<string>",
"binding_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"in_use": true,
"owner": "<string>",
"status": "connected"
}
],
"last_activity": {
"at": "2023-11-07T05:31:56Z",
"kind": "mailbox_read"
},
"notification_rules": {},
"provider": "<string>",
"reauthorise_from": "<string>",
"reauthorise_token_ended": true,
"reconnect_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"setup": {
"status": "working",
"steps": [
{
"at": "2023-11-07T05:31:56Z",
"events": [
{
"at": "2023-11-07T05:31:56Z",
"line": "<string>",
"tone": "failure"
}
],
"key": "<string>",
"label": "<string>",
"status": "done"
}
]
},
"state": "connected",
"status_fact": {
"at": "2023-11-07T05:31:56Z",
"kind": "activity",
"on": "2023-11-07T05:31:56Z",
"reason": "<string>",
"target": "<string>"
},
"waiting_emails": 123
}
],
"deletion_scheduled_for": "<string>",
"description": "<string>",
"domain": "<string>",
"features": {
"advocacy": true,
"mentions_monitoring": true,
"reviews": true
},
"meta": {
"data_as_of": {
"completed_at": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"last_attempt_failed": false,
"partial": false,
"query": {},
"surfaces": {},
"updating": false
},
"name": "<string>",
"owned_domains": {
"confirmed": [
"<string>"
],
"derived": [
"<string>"
],
"dismissed": [],
"proposed": [
"<string>"
]
},
"profile": {
"alias_limit": 123,
"aliases": [
{
"name": "<string>",
"removable": true,
"source": "name"
}
],
"brand_paused": false,
"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": {},
"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",
"added_by_name": "<string>",
"check": "<string>",
"definition_version": 1,
"earlier_wordings": [
"<string>"
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"interpretation_failed": false,
"kind": "company",
"question": "<string>",
"source": {
"piece_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>"
},
"split_candidates": [
{
"check": "<string>",
"kind": "company",
"question": "<string>",
"statement": "<string>",
"suggestion": "<string>"
}
],
"statement": "<string>",
"suggestion": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"version": 2
}
],
"next_fact_check_at": "2023-11-07T05:31:56Z",
"personas": [
{
"ai_generated": true,
"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>",
"customer_size": "<string>",
"differentiators": "<string>",
"ecommerce": false,
"measured_product_line": "<string>",
"moving_away_from": [
"<string>"
],
"offering": "<string>",
"product_lines": [
{
"category": "<string>",
"name": "<string>",
"target_buyer": "<string>"
}
],
"sells_to": "businesses",
"service_area": "<string>",
"tone": {
"complexity": "technical",
"formality": "formal"
},
"use_cases": [
"<string>"
]
},
"review_profile_urls": [
{
"label": "<string>",
"platform": "<string>",
"url": "<string>"
}
],
"rival_cap": 123,
"rivals": [
{
"brand_key": "<string>",
"brand_name": "<string>",
"source": "<string>",
"status": "<string>"
}
]
},
"prompts_reserved": 123,
"prompts_used": 123
}{
"code": "invalid_cursor",
"detail": "The cursor is invalid or belongs to a different query.",
"instance": "example-request-id",
"status": 400,
"title": "Bad Request",
"type": "https://docs.heralded.ai/errors-and-limits#invalid_cursor"
}{
"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": "https://docs.heralded.ai/errors-and-limits#invalid_token"
}{
"code": "not_found",
"detail": "Nothing here that this API key can read.",
"instance": "example-request-id",
"status": 404,
"title": "Not Found",
"type": "https://docs.heralded.ai/errors-and-limits#not_found"
}{
"code": "workspace_archived",
"detail": "The API key's organization is archived.",
"instance": "example-request-id",
"status": 409,
"title": "Conflict",
"type": "https://docs.heralded.ai/errors-and-limits#workspace_archived"
}{
"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": "https://docs.heralded.ai/errors-and-limits#invalid_request"
}{
"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": "https://docs.heralded.ai/errors-and-limits#rate_limited"
}Settings and workspaces
Get Brand Settings
Current profile, rivals, owned domains, autonomy, connection status.
GET
/
v1
/
brands
/
{brand_id}
/
settings
Get Brand Settings
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": [
{
"activity": [
{
"at": "2023-11-07T05:31:56Z",
"kind": "<string>",
"label": "<string>"
}
],
"available": true,
"binding_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"connect_another": false,
"detail": {},
"instances": [
{
"access": "personal",
"account": "<string>",
"binding_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"in_use": true,
"owner": "<string>",
"status": "connected"
}
],
"last_activity": {
"at": "2023-11-07T05:31:56Z",
"kind": "mailbox_read"
},
"notification_rules": {},
"provider": "<string>",
"reauthorise_from": "<string>",
"reauthorise_token_ended": true,
"reconnect_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"setup": {
"status": "working",
"steps": [
{
"at": "2023-11-07T05:31:56Z",
"events": [
{
"at": "2023-11-07T05:31:56Z",
"line": "<string>",
"tone": "failure"
}
],
"key": "<string>",
"label": "<string>",
"status": "done"
}
]
},
"state": "connected",
"status_fact": {
"at": "2023-11-07T05:31:56Z",
"kind": "activity",
"on": "2023-11-07T05:31:56Z",
"reason": "<string>",
"target": "<string>"
},
"waiting_emails": 123
}
],
"deletion_scheduled_for": "<string>",
"description": "<string>",
"domain": "<string>",
"features": {
"advocacy": true,
"mentions_monitoring": true,
"reviews": true
},
"meta": {
"data_as_of": {
"completed_at": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"last_attempt_failed": false,
"partial": false,
"query": {},
"surfaces": {},
"updating": false
},
"name": "<string>",
"owned_domains": {
"confirmed": [
"<string>"
],
"derived": [
"<string>"
],
"dismissed": [],
"proposed": [
"<string>"
]
},
"profile": {
"alias_limit": 123,
"aliases": [
{
"name": "<string>",
"removable": true,
"source": "name"
}
],
"brand_paused": false,
"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": {},
"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",
"added_by_name": "<string>",
"check": "<string>",
"definition_version": 1,
"earlier_wordings": [
"<string>"
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"interpretation_failed": false,
"kind": "company",
"question": "<string>",
"source": {
"piece_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>"
},
"split_candidates": [
{
"check": "<string>",
"kind": "company",
"question": "<string>",
"statement": "<string>",
"suggestion": "<string>"
}
],
"statement": "<string>",
"suggestion": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"version": 2
}
],
"next_fact_check_at": "2023-11-07T05:31:56Z",
"personas": [
{
"ai_generated": true,
"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>",
"customer_size": "<string>",
"differentiators": "<string>",
"ecommerce": false,
"measured_product_line": "<string>",
"moving_away_from": [
"<string>"
],
"offering": "<string>",
"product_lines": [
{
"category": "<string>",
"name": "<string>",
"target_buyer": "<string>"
}
],
"sells_to": "businesses",
"service_area": "<string>",
"tone": {
"complexity": "technical",
"formality": "formal"
},
"use_cases": [
"<string>"
]
},
"review_profile_urls": [
{
"label": "<string>",
"platform": "<string>",
"url": "<string>"
}
],
"rival_cap": 123,
"rivals": [
{
"brand_key": "<string>",
"brand_name": "<string>",
"source": "<string>",
"status": "<string>"
}
]
},
"prompts_reserved": 123,
"prompts_used": 123
}{
"code": "invalid_cursor",
"detail": "The cursor is invalid or belongs to a different query.",
"instance": "example-request-id",
"status": 400,
"title": "Bad Request",
"type": "https://docs.heralded.ai/errors-and-limits#invalid_cursor"
}{
"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": "https://docs.heralded.ai/errors-and-limits#invalid_token"
}{
"code": "not_found",
"detail": "Nothing here that this API key can read.",
"instance": "example-request-id",
"status": 404,
"title": "Not Found",
"type": "https://docs.heralded.ai/errors-and-limits#not_found"
}{
"code": "workspace_archived",
"detail": "The API key's organization is archived.",
"instance": "example-request-id",
"status": 409,
"title": "Conflict",
"type": "https://docs.heralded.ai/errors-and-limits#workspace_archived"
}{
"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": "https://docs.heralded.ai/errors-and-limits#invalid_request"
}{
"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": "https://docs.heralded.ai/errors-and-limits#rate_limited"
}Response
Successful Response