{
"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"
}
Visibility
Get Answer
One answer in full, with the pages it cited and the rivals it named.
{
"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"
}
Authorizations
Authorization
string
header
required
An API key, sent as Authorization: Bearer hrld_....
Path Parameters
brand_id
string<uuid>
required
The brand's UUID from listBrands.
answer_id
string<uuid>
required
An answer id from list_answers.
Query Parameters
as_of
string<uuid> | null
Completed scan id cutoff.
Response
Successful Response
also_named
NamedAnswerBrand · object[]
required
Show child attributes
asked_language
string | null
required
cited_page_count
integer
default:0
required
Distinct pages cited by this answer.
cited_pages
CitedPage · object[]
required
Show child attributes
cited_urls
string[]
required
engine
enum<string>
required
Available options:
perplexity,
gemini,
openai,
google_aio,
ai_mode,
copilot,
claude
engine_vocabulary
EngineVocabulary · object[]
required
Show child attributes
excerpt
string
required
excerpt_highlights
AnswerHighlightSpan · object[]
required
Show child attributes
highlights
AnswerHighlightSpan · object[]
required
Show child attributes
id
string<uuid>
required
language
string
default:unknown
required
mentioned
boolean | null
required
meta
Meta · object
required
Normalized query and newest included scan.
Show child attributes
own_cited_page_count
integer
default:0
required
Distinct owned pages cited by this answer.
prompt
string
required
prompt_id
string<uuid>
required
read_at
string<date-time>
required
recommended
boolean | null
required
rival_brands
string[]
required
rivals_named
string[]
required
run_class
string | null
required
run_number
integer | null
required
segment
string
required
segment_config_version
integer | null
required
segment_detail
AnswerReadSegment · object | null
required
Show child attributes
states
AnswerReadStates · object
required
The four words for how one answer treated the brand (D32, D37).
The wire shape of app.scans.scoring.axes.AnswerAxes, which is where the
reading itself is decided — the report, the roll-ups and this history all
read one answer the same way. None is unmeasured and never a zero.
Show child attributes
subject_brand
string | null
required
text
string
required
text_retained
boolean
default:true
required
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Heralded","colors":{"primary":"#8a6410","light":"#f0b545","dark":"#b57c1d"},"logo":{"light":"https://mintcdn.com/growth-path/c9JZqZZJeoekc9h3/logo/heralded-light.svg?fit=max\u0026auto=format\u0026n=c9JZqZZJeoekc9h3\u0026q=85\u0026s=348eea39d63635c9b888a413b15ada1e","dark":"https://mintcdn.com/growth-path/c9JZqZZJeoekc9h3/logo/heralded-dark.svg?fit=max\u0026auto=format\u0026n=c9JZqZZJeoekc9h3\u0026q=85\u0026s=6da1fdb0555f0bcf2ba9f09cf30452f3","href":"https://heralded.ai"},"favicon":"https://mintcdn.com/growth-path/ZSYm8Tfs8DiC_uz7/favicon.svg?fit=max\u0026auto=format\u0026n=ZSYm8Tfs8DiC_uz7\u0026q=85\u0026s=a0a11c94c0397741d9f04799b8d1d278","api":{"playground":{"display":"interactive"}},"background":{"decoration":"grid","color":{"light":"#f8f8f6","dark":"#10100f"}},"navbar":{"primary":{"type":"button","label":"Open Heralded","href":"https://app.heralded.ai"}},"footer":{"socials":{"website":"https://heralded.ai"}},"fonts":{"family":"Schibsted Grotesk"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"growth-path","hasAudioNarration":false,"actualSubdomain":"growth-path","customDomains":["docs.heralded.ai"],"gitSource":{"type":"github","owner":"growthpath-ai","repo":"heralded","deployBranch":"main","contentDirectory":"docs-site","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6b02c14293edbf63bed54c5b","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API reference","count":60},{"language":"default","tag":"Guides","count":34},{"language":"default","tag":"Methodology","count":22},{"language":"default","tag":"Visibility","count":19},{"language":"default","tag":"What Heralded measures","count":13},{"language":"default","tag":"Get started","count":11},{"language":"default","tag":"Actions","count":8},{"language":"default","tag":"Site","count":8},{"language":"default","tag":"Your workspace","count":7},{"language":"default","tag":"Developers","count":7}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":"/* vietnamese */\n@font-face {\n font-family: 'Fraunces';\n font-style: normal;\n font-weight: 500 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/fraunces/v38/6NU78FyLNQOQZAnv9bYEvDiIdE9Ea92uemAk_WBq8U_9v0c2Wa0KxCBTeO-U.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Fraunces';\n font-style: normal;\n font-weight: 500 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/fraunces/v38/6NU78FyLNQOQZAnv9bYEvDiIdE9Ea92uemAk_WBq8U_9v0c2Wa0KxCFTeO-U.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Fraunces';\n font-style: normal;\n font-weight: 500 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/fraunces/v38/6NU78FyLNQOQZAnv9bYEvDiIdE9Ea92uemAk_WBq8U_9v0c2Wa0KxC9TeA.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n#page-title,#content h2,#content h3,#content h4{font-family:'Fraunces', Georgia, 'Times New Roman', serif;font-weight:600;letter-spacing:-0.01em}#topbar-cta-button a,#topbar-cta-button .text-white{color:#202018}#topbar-cta-button a>span:first-child{border-radius:9999px;background-color:#f0b545}#topbar-cta-button a:hover>span:first-child{background-color:#f6cf74;opacity:1}#topbar-cta-button a svg{color:#202018}#search-bar-entry{border-radius:9999px}.tryit-button,div:has(>div>.tryit-button),div:has(>div>.tryit-button)>div>:first-child{border-radius:9999px}"}]}
{"page":{"pagePath":"api-reference/v1/get-answer","slug":"/api-reference/v1/get-answer","pageMetadata":{"title":"Get Answer","description":"One answer in full, with the pages it cited and the rivals it named.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/answers/{answer_id}","href":"/api-reference/v1/get-answer","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"One answer in full, with the pages it cited and the rivals it named.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get Answer","description":"One answer in full, with the pages it cited and the rivals it named.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/answers/{answer_id}","href":"/api-reference/v1/get-answer","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/growth-path/f6cffd90abc22b81/api-reference/functions/heralded.js"],"openApiReferenceData":{"operation":{"description":"One answer in full, with the pages it cited and the rivals it named.","operationId":"getAnswer","parameters":["db1dad50-8633-4524-8621-15307d4af66f","9517f13c-4912-45bd-ad57-090e003b783c","c78fd17e-f224-4431-835b-368097521791"],"responses":{"200":"7b4bb528-f7ef-40b6-929b-8ecedb0be504","400":"237f62f9-12f4-4864-8c5a-cd26deca0d10","401":"ea63c77e-c458-430b-93ad-f908320ef72d","404":"c5c200de-bca9-4f99-a50b-77aa4cdff606","409":"f74a935a-9e57-4222-bc74-068181b008ed","422":"f297049c-9ad1-4c47-a1f3-b55188bf04ce","429":"6757693f-1b76-4b86-9f6f-bbc599b07b62"},"security":["c841a796-b6b5-4050-a387-daf1965e2400"],"summary":"Get Answer","tags":["v1"],"method":"get","type":"path","servers":["2a6c7223-f392-4ed2-a23e-e38a17bdf9a0"],"path":"/v1/brands/{brand_id}/answers/{answer_id}","baseUrlOptions":["https://api.heralded.ai"],"title":"Get Answer","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"db1dad50-8633-4524-8621-15307d4af66f":{"description":"The brand's UUID from listBrands.","in":"path","name":"brand_id","required":true,"schema":{"description":"The brand's UUID from listBrands.","format":"uuid","title":"Brand Id","type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"}},"9517f13c-4912-45bd-ad57-090e003b783c":{"description":"An answer id from list_answers.","in":"path","name":"answer_id","required":true,"schema":{"description":"An answer id from list_answers.","format":"uuid","title":"Answer Id","type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"}},"c78fd17e-f224-4431-835b-368097521791":{"description":"Completed scan id cutoff.","in":"query","name":"as_of","required":false,"schema":{"oneOf":[{"type":"string","title":"As Of","description":"Completed scan id cutoff.","format":"uuid","uniqueKey":"oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","title":"As Of","description":"Completed scan id cutoff.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cuuid> | null"}}},"responses":{"7b4bb528-f7ef-40b6-929b-8ecedb0be504":{"content":{"application/json":{"schema":{"examples":[{"also_named":[],"asked_language":null,"cited_page_count":0,"cited_pages":[],"cited_urls":["https://example.com/best-agency-crm"],"engine":"openai","engine_vocabulary":[],"excerpt":"For agencies, Acme and Rival lead...","excerpt_highlights":[],"highlights":[],"id":"5d2e8c1f-7a3b-4c6d-9e0f-1a2b3c4d5e6f","language":"unknown","mentioned":true,"meta":{"data_as_of":null,"last_attempt_failed":false,"partial":false,"query":{},"surfaces":{},"updating":false},"own_cited_page_count":0,"prompt":"best crm for agencies","prompt_id":"0b8e5f7a-2c4d-4e6f-8a1b-3c5d7e9f1a2b","read_at":"2026-09-22T09:00:00Z","recommended":true,"rival_brands":[],"rivals_named":["Rival"],"run_class":null,"run_number":null,"segment":"Agencies","segment_config_version":null,"segment_detail":null,"states":{"icon_states":{"mentioned":"not_measured","praised":"not_measured","recommended":"not_measured","understood":"not_measured"},"mentioned":null,"praised":null,"recommended":null,"understood":null},"subject_brand":null,"text":"For agencies, Acme and Rival lead the field.","text_retained":true}],"properties":{"also_named":{"items":{"properties":{"domain":{"oneOf":[{"type":"string","title":"Domain","isRequired":true,"uniqueKey":"also_named.items.[INDEX].domain.oneOf.0","typeLabel":"string"},{"type":"null","title":"Domain","isRequired":true,"uniqueKey":"also_named.items.[INDEX].domain.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"also_named.items.[INDEX].domain","typeLabel":"string | null"},"name":{"title":"Name","type":"string","isRequired":true,"uniqueKey":"also_named.items.[INDEX].name","typeLabel":"string"},"tracked":{"default":false,"title":"Tracked","type":"boolean","isRequired":true,"uniqueKey":"also_named.items.[INDEX].tracked","typeLabel":"boolean"}},"required":["name","domain","tracked"],"title":"NamedAnswerBrand","type":"object","uniqueKey":"also_named.items.[INDEX]","typeLabel":"NamedAnswerBrand · object"},"title":"Also Named","type":"array","isRequired":true,"uniqueKey":"also_named","typeLabel":"NamedAnswerBrand · object[]"},"asked_language":{"oneOf":[{"type":"string","title":"Asked Language","isRequired":true,"uniqueKey":"asked_language.oneOf.0","typeLabel":"string"},{"type":"null","title":"Asked Language","isRequired":true,"uniqueKey":"asked_language.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"asked_language","typeLabel":"string | null"},"cited_page_count":{"default":0,"description":"Distinct pages cited by this answer.","title":"Cited Page Count","type":"integer","isRequired":true,"uniqueKey":"cited_page_count","typeLabel":"integer"},"cited_pages":{"items":{"properties":{"document_key":{"title":"Document Key","type":"string","isRequired":true,"uniqueKey":"cited_pages.items.[INDEX].document_key","typeLabel":"string"},"domain":{"title":"Domain","type":"string","isRequired":true,"uniqueKey":"cited_pages.items.[INDEX].domain","typeLabel":"string"},"language":{"default":"unknown","title":"Language","type":"string","isRequired":true,"uniqueKey":"cited_pages.items.[INDEX].language","typeLabel":"string"},"title":{"oneOf":[{"type":"string","title":"Title","isRequired":true,"uniqueKey":"cited_pages.items.[INDEX].title.oneOf.0","typeLabel":"string"},{"type":"null","title":"Title","isRequired":true,"uniqueKey":"cited_pages.items.[INDEX].title.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"cited_pages.items.[INDEX].title","typeLabel":"string | null"},"url":{"title":"Url","type":"string","isRequired":true,"uniqueKey":"cited_pages.items.[INDEX].url","typeLabel":"string"}},"required":["language","url","document_key","title","domain"],"title":"CitedPage","type":"object","uniqueKey":"cited_pages.items.[INDEX]","typeLabel":"CitedPage · object"},"title":"Cited Pages","type":"array","isRequired":true,"uniqueKey":"cited_pages","typeLabel":"CitedPage · object[]"},"cited_urls":{"items":{"type":"string","uniqueKey":"cited_urls.items.[INDEX]","typeLabel":"string"},"title":"Cited Urls","type":"array","isRequired":true,"uniqueKey":"cited_urls","typeLabel":"string[]"},"engine":{"enum":["perplexity","gemini","openai","google_aio","ai_mode","copilot","claude"],"title":"Engine","type":"string","isRequired":true,"uniqueKey":"engine","typeLabel":"enum\u003cstring>"},"engine_vocabulary":{"items":{"properties":{"display_name":{"title":"Display Name","type":"string","isRequired":true,"uniqueKey":"engine_vocabulary.items.[INDEX].display_name","typeLabel":"string"},"engine_id":{"title":"Engine Id","type":"string","isRequired":true,"uniqueKey":"engine_vocabulary.items.[INDEX].engine_id","typeLabel":"string"},"sort_order":{"title":"Sort Order","type":"integer","isRequired":true,"uniqueKey":"engine_vocabulary.items.[INDEX].sort_order","typeLabel":"integer"}},"required":["engine_id","display_name","sort_order"],"title":"EngineVocabulary","type":"object","uniqueKey":"engine_vocabulary.items.[INDEX]","typeLabel":"EngineVocabulary · object"},"title":"Engine Vocabulary","type":"array","isRequired":true,"uniqueKey":"engine_vocabulary","typeLabel":"EngineVocabulary · object[]"},"excerpt":{"title":"Excerpt","type":"string","isRequired":true,"uniqueKey":"excerpt","typeLabel":"string"},"excerpt_highlights":{"items":{"description":"One place the answer names the brand or a rival, for the overlay to\nmark: half-open offsets into `answer_text`, counted in Unicode code\npoints, with `you` for the brand's own names and `rival` for a rival's.","properties":{"brand":{"enum":["you","rival"],"title":"Brand","type":"string","isRequired":true,"uniqueKey":"excerpt_highlights.items.[INDEX].brand","typeLabel":"enum\u003cstring>"},"end":{"minimum":0,"title":"End","type":"integer","isRequired":true,"uniqueKey":"excerpt_highlights.items.[INDEX].end","typeLabel":"integer"},"start":{"minimum":0,"title":"Start","type":"integer","isRequired":true,"uniqueKey":"excerpt_highlights.items.[INDEX].start","typeLabel":"integer"}},"required":["start","end","brand"],"title":"AnswerHighlightSpan","type":"object","uniqueKey":"excerpt_highlights.items.[INDEX]","typeLabel":"AnswerHighlightSpan · object"},"title":"Excerpt Highlights","type":"array","isRequired":true,"uniqueKey":"excerpt_highlights","typeLabel":"AnswerHighlightSpan · object[]"},"highlights":{"items":{"description":"One place the answer names the brand or a rival, for the overlay to\nmark: half-open offsets into `answer_text`, counted in Unicode code\npoints, with `you` for the brand's own names and `rival` for a rival's.","properties":{"brand":{"enum":["you","rival"],"title":"Brand","type":"string","isRequired":true,"uniqueKey":"highlights.items.[INDEX].brand","typeLabel":"enum\u003cstring>"},"end":{"minimum":0,"title":"End","type":"integer","isRequired":true,"uniqueKey":"highlights.items.[INDEX].end","typeLabel":"integer"},"start":{"minimum":0,"title":"Start","type":"integer","isRequired":true,"uniqueKey":"highlights.items.[INDEX].start","typeLabel":"integer"}},"required":["start","end","brand"],"title":"AnswerHighlightSpan","type":"object","uniqueKey":"highlights.items.[INDEX]","typeLabel":"AnswerHighlightSpan · object"},"title":"Highlights","type":"array","isRequired":true,"uniqueKey":"highlights","typeLabel":"AnswerHighlightSpan · object[]"},"id":{"format":"uuid","title":"Id","type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"language":{"default":"unknown","title":"Language","type":"string","isRequired":true,"uniqueKey":"language","typeLabel":"string"},"mentioned":{"oneOf":[{"type":"boolean","title":"Mentioned","isRequired":true,"uniqueKey":"mentioned.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Mentioned","isRequired":true,"uniqueKey":"mentioned.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"mentioned","typeLabel":"boolean | null"},"meta":{"properties":{"data_as_of":{"oneOf":[{"type":"object","title":"DataAsOf","required":["id","completed_at"],"properties":{"completed_at":{"format":"date-time","title":"Completed At","type":"string","isRequired":true,"uniqueKey":"meta.data_as_of.oneOf.0.completed_at","typeLabel":"string\u003cdate-time>"},"id":{"format":"uuid","title":"Id","type":"string","isRequired":true,"uniqueKey":"meta.data_as_of.oneOf.0.id","typeLabel":"string\u003cuuid>"}},"isRequired":true,"uniqueKey":"meta.data_as_of.oneOf.0","typeLabel":"DataAsOf · object"},{"type":"null","isRequired":true,"uniqueKey":"meta.data_as_of.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"meta.data_as_of","typeLabel":"DataAsOf · object | null"},"last_attempt_failed":{"default":false,"description":"The newest attempt failed; the last good result is displayed.","title":"Last Attempt Failed","type":"boolean","isRequired":true,"uniqueKey":"meta.last_attempt_failed","typeLabel":"boolean"},"partial":{"default":false,"description":"The displayed response includes a partial report.","title":"Partial","type":"boolean","isRequired":true,"uniqueKey":"meta.partial","typeLabel":"boolean"},"query":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"meta.query.additionalProperties","typeLabel":"any"},"title":"Query","type":"object","isRequired":true,"uniqueKey":"meta.query","typeLabel":"Query · object"},"surfaces":{"additionalProperties":{"properties":{"as_of":{"oneOf":[{"type":"object","title":"SurfaceAsOf","description":"The result displayed here.","required":["scan_id","at"],"properties":{"at":{"description":"When the displayed result was measured.","format":"date-time","title":"At","type":"string","isRequired":true,"uniqueKey":"meta.surfaces.additionalProperties.as_of.oneOf.0.at","typeLabel":"string\u003cdate-time>"},"scan_id":{"oneOf":[{"type":"string","title":"Scan Id","description":"The result's scan, null for a timestamp-only result.","format":"uuid","isRequired":true,"uniqueKey":"meta.surfaces.additionalProperties.as_of.oneOf.0.scan_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","title":"Scan Id","description":"The result's scan, null for a timestamp-only result.","isRequired":true,"uniqueKey":"meta.surfaces.additionalProperties.as_of.oneOf.0.scan_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"meta.surfaces.additionalProperties.as_of.oneOf.0.scan_id","typeLabel":"string\u003cuuid> | null"}},"isRequired":true,"uniqueKey":"meta.surfaces.additionalProperties.as_of.oneOf.0","typeLabel":"SurfaceAsOf · object"},{"type":"null","description":"The result displayed here.","isRequired":true,"uniqueKey":"meta.surfaces.additionalProperties.as_of.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"meta.surfaces.additionalProperties.as_of","typeLabel":"SurfaceAsOf · object | null"},"last_attempt_failed":{"default":false,"description":"The newest attempt failed; any displayed result is retained.","title":"Last Attempt Failed","type":"boolean","isRequired":true,"uniqueKey":"meta.surfaces.additionalProperties.last_attempt_failed","typeLabel":"boolean"},"partial":{"default":false,"description":"The displayed report is partial.","title":"Partial","type":"boolean","isRequired":true,"uniqueKey":"meta.surfaces.additionalProperties.partial","typeLabel":"boolean"},"updating":{"default":false,"description":"A newer attempt exists whose result is not yet displayed.","title":"Updating","type":"boolean","isRequired":true,"uniqueKey":"meta.surfaces.additionalProperties.updating","typeLabel":"boolean"}},"required":["as_of","partial","updating","last_attempt_failed"],"title":"SurfaceFreshness","type":"object","uniqueKey":"meta.surfaces.additionalProperties","typeLabel":"SurfaceFreshness · object"},"description":"Freshness by Command Center surface key. Each entry describes its own displayed result, including results without a scan.","title":"Surfaces","type":"object","isRequired":true,"uniqueKey":"meta.surfaces","typeLabel":"Surfaces · object"},"updating":{"default":false,"description":"A newer result is being produced or is not yet displayed.","title":"Updating","type":"boolean","isRequired":true,"uniqueKey":"meta.updating","typeLabel":"boolean"}},"required":["query","data_as_of","partial","updating","last_attempt_failed","surfaces"],"title":"Meta","type":"object","description":"Normalized query and newest included scan.","isRequired":true,"uniqueKey":"meta","typeLabel":"Meta · object"},"own_cited_page_count":{"default":0,"description":"Distinct owned pages cited by this answer.","title":"Own Cited Page Count","type":"integer","isRequired":true,"uniqueKey":"own_cited_page_count","typeLabel":"integer"},"prompt":{"title":"Prompt","type":"string","isRequired":true,"uniqueKey":"prompt","typeLabel":"string"},"prompt_id":{"format":"uuid","title":"Prompt Id","type":"string","isRequired":true,"uniqueKey":"prompt_id","typeLabel":"string\u003cuuid>"},"read_at":{"format":"date-time","title":"Read At","type":"string","isRequired":true,"uniqueKey":"read_at","typeLabel":"string\u003cdate-time>"},"recommended":{"oneOf":[{"type":"boolean","title":"Recommended","isRequired":true,"uniqueKey":"recommended.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Recommended","isRequired":true,"uniqueKey":"recommended.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"recommended","typeLabel":"boolean | null"},"rival_brands":{"items":{"type":"string","uniqueKey":"rival_brands.items.[INDEX]","typeLabel":"string"},"title":"Rival Brands","type":"array","isRequired":true,"uniqueKey":"rival_brands","typeLabel":"string[]"},"rivals_named":{"items":{"type":"string","uniqueKey":"rivals_named.items.[INDEX]","typeLabel":"string"},"title":"Rivals Named","type":"array","isRequired":true,"uniqueKey":"rivals_named","typeLabel":"string[]"},"run_class":{"oneOf":[{"type":"string","title":"Run Class","isRequired":true,"uniqueKey":"run_class.oneOf.0","typeLabel":"string"},{"type":"null","title":"Run Class","isRequired":true,"uniqueKey":"run_class.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"run_class","typeLabel":"string | null"},"run_number":{"oneOf":[{"type":"integer","title":"Run Number","isRequired":true,"uniqueKey":"run_number.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Run Number","isRequired":true,"uniqueKey":"run_number.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"run_number","typeLabel":"integer | null"},"segment":{"title":"Segment","type":"string","isRequired":true,"uniqueKey":"segment","typeLabel":"string"},"segment_config_version":{"oneOf":[{"type":"integer","title":"Segment Config Version","isRequired":true,"uniqueKey":"segment_config_version.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Segment Config Version","isRequired":true,"uniqueKey":"segment_config_version.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"segment_config_version","typeLabel":"integer | null"},"segment_detail":{"oneOf":[{"type":"object","title":"AnswerReadSegment","required":["label","persona_id","geo"],"properties":{"geo":{"title":"Geo","type":"string","isRequired":true,"uniqueKey":"segment_detail.oneOf.0.geo","typeLabel":"string"},"label":{"title":"Label","type":"string","isRequired":true,"uniqueKey":"segment_detail.oneOf.0.label","typeLabel":"string"},"persona_id":{"title":"Persona Id","type":"string","isRequired":true,"uniqueKey":"segment_detail.oneOf.0.persona_id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"segment_detail.oneOf.0","typeLabel":"AnswerReadSegment · object"},{"type":"null","isRequired":true,"uniqueKey":"segment_detail.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"segment_detail","typeLabel":"AnswerReadSegment · object | null"},"states":{"description":"The four words for how one answer treated the brand (D32, D37).\n\nThe wire shape of `app.scans.scoring.axes.AnswerAxes`, which is where the\nreading itself is decided — the report, the roll-ups and this history all\nread one answer the same way. `None` is unmeasured and never a zero.","properties":{"icon_states":{"description":"Each axis as the icon a row draws for it.","properties":{"mentioned":{"enum":["yes","partial","no","not_measured"],"title":"Mentioned","type":"string","isRequired":true,"uniqueKey":"states.icon_states.mentioned","typeLabel":"enum\u003cstring>"},"praised":{"enum":["yes","partial","no","not_measured"],"title":"Praised","type":"string","isRequired":true,"uniqueKey":"states.icon_states.praised","typeLabel":"enum\u003cstring>"},"recommended":{"enum":["yes","partial","no","not_measured"],"title":"Recommended","type":"string","isRequired":true,"uniqueKey":"states.icon_states.recommended","typeLabel":"enum\u003cstring>"},"understood":{"enum":["yes","partial","no","not_measured"],"title":"Understood","type":"string","isRequired":true,"uniqueKey":"states.icon_states.understood","typeLabel":"enum\u003cstring>"}},"required":["mentioned","understood","recommended","praised"],"title":"IconStates","type":"object","readOnly":true,"isRequired":true,"uniqueKey":"states.icon_states","typeLabel":"IconStates · object"},"mentioned":{"oneOf":[{"type":"boolean","title":"Mentioned","isRequired":true,"uniqueKey":"states.mentioned.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Mentioned","isRequired":true,"uniqueKey":"states.mentioned.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"states.mentioned","typeLabel":"boolean | null"},"praised":{"oneOf":[{"type":"boolean","title":"Praised","isRequired":true,"uniqueKey":"states.praised.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Praised","isRequired":true,"uniqueKey":"states.praised.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"states.praised","typeLabel":"boolean | null"},"recommended":{"oneOf":[{"type":"boolean","title":"Recommended","isRequired":true,"uniqueKey":"states.recommended.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Recommended","isRequired":true,"uniqueKey":"states.recommended.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"states.recommended","typeLabel":"boolean | null"},"understood":{"oneOf":[{"type":"number","title":"Understood","isRequired":true,"uniqueKey":"states.understood.oneOf.0","typeLabel":"number"},{"type":"null","title":"Understood","isRequired":true,"uniqueKey":"states.understood.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"states.understood","typeLabel":"number | null"}},"required":["mentioned","understood","recommended","praised","icon_states"],"title":"AnswerReadStates","type":"object","isRequired":true,"uniqueKey":"states","typeLabel":"AnswerReadStates · object"},"subject_brand":{"oneOf":[{"type":"string","title":"Subject Brand","isRequired":true,"uniqueKey":"subject_brand.oneOf.0","typeLabel":"string"},{"type":"null","title":"Subject Brand","isRequired":true,"uniqueKey":"subject_brand.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"subject_brand","typeLabel":"string | null"},"text":{"title":"Text","type":"string","isRequired":true,"uniqueKey":"text","typeLabel":"string"},"text_retained":{"default":true,"title":"Text Retained","type":"boolean","isRequired":true,"uniqueKey":"text_retained","typeLabel":"boolean"}},"required":["meta","asked_language","language","id","prompt_id","prompt","engine","segment","read_at","mentioned","recommended","excerpt","states","segment_detail","run_number","run_class","segment_config_version","cited_page_count","own_cited_page_count","also_named","text_retained","excerpt_highlights","text","cited_urls","rivals_named","engine_vocabulary","cited_pages","subject_brand","rival_brands","highlights"],"title":"V1Answer","type":"object","uniqueKey":"","typeLabel":"V1Answer · object"},"examples":{"Example":{"title":"Example","value":{"also_named":[],"asked_language":null,"cited_page_count":0,"cited_pages":[],"cited_urls":["https://example.com/best-agency-crm"],"engine":"openai","engine_vocabulary":[],"excerpt":"For agencies, Acme and Rival lead...","excerpt_highlights":[],"highlights":[],"id":"5d2e8c1f-7a3b-4c6d-9e0f-1a2b3c4d5e6f","language":"unknown","mentioned":true,"meta":{"data_as_of":null,"last_attempt_failed":false,"partial":false,"query":{},"surfaces":{},"updating":false},"own_cited_page_count":0,"prompt":"best crm for agencies","prompt_id":"0b8e5f7a-2c4d-4e6f-8a1b-3c5d7e9f1a2b","read_at":"2026-09-22T09:00:00Z","recommended":true,"rival_brands":[],"rivals_named":["Rival"],"run_class":null,"run_number":null,"segment":"Agencies","segment_config_version":null,"segment_detail":null,"states":{"icon_states":{"mentioned":"not_measured","praised":"not_measured","recommended":"not_measured","understood":"not_measured"},"mentioned":null,"praised":null,"recommended":null,"understood":null},"subject_brand":null,"text":"For agencies, Acme and Rival lead the field.","text_retained":true}}},"exampleType":"generated"}},"description":"Successful Response","exampleType":"generated"},"237f62f9-12f4-4864-8c5a-cd26deca0d10":{"content":{"application/problem+json":{"example":{"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"},"schema":{"description":"An RFC 9457 problem linking its code to human-readable documentation.","properties":{"code":{"title":"Code","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"title":"Detail","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"instance":{"default":"","title":"Instance","type":"string","isRequired":true,"uniqueKey":"instance","typeLabel":"string"},"status":{"title":"Status","type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"title":{"title":"Title","type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"type":{"title":"Type","type":"string","isRequired":true,"uniqueKey":"type","typeLabel":"string"}},"required":["type","title","status","detail","code","instance"],"title":"Problem","type":"object","uniqueKey":"","typeLabel":"Problem · object"},"examples":{"Example":{"title":"Example","value":{"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"}}},"exampleType":"examples"}},"description":"The cursor is invalid or belongs to a different query.","exampleType":"examples"},"ea63c77e-c458-430b-93ad-f908320ef72d":{"content":{"application/problem+json":{"example":{"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"},"schema":{"description":"An RFC 9457 problem linking its code to human-readable documentation.","properties":{"code":{"title":"Code","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"title":"Detail","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"instance":{"default":"","title":"Instance","type":"string","isRequired":true,"uniqueKey":"instance","typeLabel":"string"},"status":{"title":"Status","type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"title":{"title":"Title","type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"type":{"title":"Type","type":"string","isRequired":true,"uniqueKey":"type","typeLabel":"string"}},"required":["type","title","status","detail","code","instance"],"title":"Problem","type":"object","uniqueKey":"","typeLabel":"Problem · object"},"examples":{"Example":{"title":"Example","value":{"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"}}},"exampleType":"examples"}},"description":"No API key, or one that is unknown, revoked or expired.","headers":{"WWW-Authenticate":{"schema":{"example":"Bearer","type":"string"}}},"exampleType":"examples"},"c5c200de-bca9-4f99-a50b-77aa4cdff606":{"content":{"application/problem+json":{"example":{"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"},"schema":{"description":"An RFC 9457 problem linking its code to human-readable documentation.","properties":{"code":{"title":"Code","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"title":"Detail","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"instance":{"default":"","title":"Instance","type":"string","isRequired":true,"uniqueKey":"instance","typeLabel":"string"},"status":{"title":"Status","type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"title":{"title":"Title","type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"type":{"title":"Type","type":"string","isRequired":true,"uniqueKey":"type","typeLabel":"string"}},"required":["type","title","status","detail","code","instance"],"title":"Problem","type":"object","uniqueKey":"","typeLabel":"Problem · object"},"examples":{"Example":{"title":"Example","value":{"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"}}},"exampleType":"examples"}},"description":"No such brand or answer, or the key's owner cannot read it.","exampleType":"examples"},"f74a935a-9e57-4222-bc74-068181b008ed":{"content":{"application/problem+json":{"example":{"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"},"schema":{"description":"An RFC 9457 problem linking its code to human-readable documentation.","properties":{"code":{"title":"Code","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"title":"Detail","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"instance":{"default":"","title":"Instance","type":"string","isRequired":true,"uniqueKey":"instance","typeLabel":"string"},"status":{"title":"Status","type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"title":{"title":"Title","type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"type":{"title":"Type","type":"string","isRequired":true,"uniqueKey":"type","typeLabel":"string"}},"required":["type","title","status","detail","code","instance"],"title":"Problem","type":"object","uniqueKey":"","typeLabel":"Problem · object"},"examples":{"Example":{"title":"Example","value":{"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"}}},"exampleType":"examples"}},"description":"The API key's organization is archived.","exampleType":"examples"},"f297049c-9ad1-4c47-a1f3-b55188bf04ce":{"content":{"application/problem+json":{"example":{"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"},"schema":{"properties":{"code":{"title":"Code","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"title":"Detail","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"errors":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"errors.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"errors.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"errors.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"title":"Loc","type":"array","isRequired":true,"uniqueKey":"errors.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"title":"Msg","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].msg","typeLabel":"string"},"type":{"title":"Type","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].type","typeLabel":"string"}},"required":["loc","msg","type"],"title":"ValidationIssue","type":"object","uniqueKey":"errors.items.[INDEX]","typeLabel":"ValidationIssue · object"},"title":"Errors","type":"array","isRequired":true,"uniqueKey":"errors","typeLabel":"ValidationIssue · object[]"},"instance":{"default":"","title":"Instance","type":"string","isRequired":true,"uniqueKey":"instance","typeLabel":"string"},"status":{"title":"Status","type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"title":{"title":"Title","type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"type":{"title":"Type","type":"string","isRequired":true,"uniqueKey":"type","typeLabel":"string"}},"required":["type","title","status","detail","code","instance","errors"],"title":"ValidationProblem","type":"object","uniqueKey":"","typeLabel":"ValidationProblem · object"},"examples":{"Example":{"title":"Example","value":{"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"}}},"exampleType":"examples"}},"description":"A path or query parameter is invalid.","exampleType":"examples"},"6757693f-1b76-4b86-9f6f-bbc599b07b62":{"content":{"application/problem+json":{"example":{"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"},"schema":{"properties":{"code":{"title":"Code","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"title":"Detail","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"instance":{"default":"","title":"Instance","type":"string","isRequired":true,"uniqueKey":"instance","typeLabel":"string"},"rate_limit":{"properties":{"limit":{"title":"Limit","type":"integer","isRequired":true,"uniqueKey":"rate_limit.limit","typeLabel":"integer"},"remaining":{"title":"Remaining","type":"integer","isRequired":true,"uniqueKey":"rate_limit.remaining","typeLabel":"integer"},"reset":{"title":"Reset","type":"integer","isRequired":true,"uniqueKey":"rate_limit.reset","typeLabel":"integer"},"window":{"title":"Window","type":"integer","isRequired":true,"uniqueKey":"rate_limit.window","typeLabel":"integer"}},"required":["limit","window","remaining","reset"],"title":"RateLimitValues","type":"object","isRequired":true,"uniqueKey":"rate_limit","typeLabel":"RateLimitValues · object"},"status":{"title":"Status","type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"title":{"title":"Title","type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"type":{"title":"Type","type":"string","isRequired":true,"uniqueKey":"type","typeLabel":"string"}},"required":["type","title","status","detail","code","instance","rate_limit"],"title":"RateLimitProblem","type":"object","uniqueKey":"","typeLabel":"RateLimitProblem · object"},"examples":{"Example":{"title":"Example","value":{"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"}}},"exampleType":"examples"}},"description":"The API key made more than 120 requests in the minute.","headers":{"Retry-After":{"description":"Seconds until the key may call again.","schema":{"example":60,"type":"integer"}}},"exampleType":"examples"}},"security":{"c841a796-b6b5-4050-a387-daf1965e2400":{"apiKey":{"description":"An API key, sent as `Authorization: Bearer hrld_...`.","scheme":"bearer","type":"http","scopes":[],"schemeName":"apiKey"}}},"servers":{"2a6c7223-f392-4ed2-a23e-e38a17bdf9a0":{"url":"https://api.heralded.ai"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"description":"An API key, sent as `Authorization: Bearer hrld_...`.","scheme":"bearer","type":"http","scopes":[],"schemeName":"apiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"An API key, sent as `Authorization: Bearer hrld_...`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"apiKey","name":"Authorization"}],"title":"apiKey"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"growth-path","siteName":"Heralded","title":"Get Answer - Heralded","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-22T10:17:49.601Z","originalFileLocation":"api-reference/v1/get-answer.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"One answer in full, with the pages it cited and the rivals it named.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Heralded\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/growth-path/SP80dJI2EeXRxpqo/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/growth-path/SP80dJI2EeXRxpqo/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/growth-path/SP80dJI2EeXRxpqo/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/growth-path/SP80dJI2EeXRxpqo/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/growth-path/SP80dJI2EeXRxpqo/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/growth-path/SP80dJI2EeXRxpqo/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/growth-path/SP80dJI2EeXRxpqo/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/growth-path/SP80dJI2EeXRxpqo/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/growth-path/SP80dJI2EeXRxpqo/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Answer - Heralded\">\u003cmeta data-mint-head property=\"og:description\" content=\"One answer in full, with the pages it cited and the rivals it named.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Heralded\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.heralded.ai/api-reference/v1/get-answer\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://growth-path.mintlify.site/_mintlify/api/og/v2?division=Visibility\u0026amp;title=Get+Answer\u0026amp;description=One+answer+in+full%2C+with+the+pages+it+cited+and+the+rivals+it+named.\u0026amp;theme=84eff0b460cc923231a17d34\u0026amp;signature=7ccd67e1504b2e57159d68c0e82c0fdef01e91fdc37398263c2e35dd5889e5ba\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get Answer - Heralded\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"One answer in full, with the pages it cited and the rivals it named.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://growth-path.mintlify.site/_mintlify/api/og/v2?division=Visibility\u0026amp;title=Get+Answer\u0026amp;description=One+answer+in+full%2C+with+the+pages+it+cited+and+the+rivals+it+named.\u0026amp;theme=84eff0b460cc923231a17d34\u0026amp;signature=7ccd67e1504b2e57159d68c0e82c0fdef01e91fdc37398263c2e35dd5889e5ba\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/growth-path/SP80dJI2EeXRxpqo/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Heralded\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#8a6410\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.heralded.ai/api-reference/v1/get-answer\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/v1/get-answer.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.heralded.ai/#organization\",\"name\":\"Heralded\",\"url\":\"https://docs.heralded.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/growth-path/c9JZqZZJeoekc9h3/logo/heralded-light.svg?fit=max\u0026auto=format\u0026n=c9JZqZZJeoekc9h3\u0026q=85\u0026s=348eea39d63635c9b888a413b15ada1e\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.heralded.ai#website\",\"name\":\"Heralded\",\"url\":\"https://docs.heralded.ai\",\"publisher\":{\"@id\":\"https://docs.heralded.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.heralded.ai/api-reference/v1/get-answer#webpage\",\"url\":\"https://docs.heralded.ai/api-reference/v1/get-answer\",\"name\":\"Get Answer\",\"description\":\"One answer in full, with the pages it cited and the rivals it named.\",\"dateModified\":\"2026-11-22T10:17:49.601Z\",\"isPartOf\":{\"@id\":\"https://docs.heralded.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.heralded.ai/api-reference/v1/get-answer#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.heralded.ai/api-reference/v1/get-answer#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Visibility\",\"item\":\"https://docs.heralded.ai/api-reference/v1/get-scores\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get Answer\",\"item\":\"https://docs.heralded.ai/api-reference/v1/get-answer\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.heralded.ai/api-reference/v1/get-answer#apireference\",\"headline\":\"Get Answer\",\"name\":\"Get Answer\",\"description\":\"One answer in full, with the pages it cited and the rivals it named.\",\"url\":\"https://docs.heralded.ai/api-reference/v1/get-answer\",\"mainEntityOfPage\":{\"@id\":\"https://docs.heralded.ai/api-reference/v1/get-answer#webpage\"},\"dateModified\":\"2026-11-22T10:17:49.601Z\",\"publisher\":{\"@id\":\"https://docs.heralded.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.heralded.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Heralded\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Heralded\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/v1/get-answer.md","siteName":"Heralded","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"Methodology","pages":[{"title":"Methodology","href":"/methodology/how-we-measure"}]},{"tab":"Developers","pages":[{"title":"Developers","href":"/developers"}]},{"tab":"API reference","groups":[{"group":"Leaderboards","pages":[{"title":"Get Leaderboards","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/leaderboards","href":"/api-reference/v1/get-leaderboards"},{"title":"Get Hall Of Fame","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/leaderboards/hall-of-fame","href":"/api-reference/v1/get-hall-of-fame"},{"title":"Get Sources Hall Of Fame","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/leaderboards/hall-of-fame/sources","href":"/api-reference/v1/get-sources-hall-of-fame"},{"title":"Get Facets","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/leaderboards/facets","href":"/api-reference/v1/get-facets"},{"title":"Get Brand","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/leaderboards/brands/{slug}","href":"/api-reference/v1/get-brand"},{"title":"Get Source","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/sources/{domain}","href":"/api-reference/v1/get-source"}]},{"group":"Brands","pages":[{"title":"Get Brands","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands","href":"/api-reference/v1/get-brands"},{"title":"Get Overview","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/overview","href":"/api-reference/v1/get-overview"},{"title":"Get Brand Snapshots","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/snapshots","href":"/api-reference/v1/get-brand-snapshots"},{"title":"Share Brand Snapshot","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/brands/{brand_id}/snapshots/{share_id}/share","href":"/api-reference/v1/share-brand-snapshot"},{"title":"Get Weekly Brief","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/weekly-brief","href":"/api-reference/v1/get-weekly-brief"},{"title":"Get Week Timeline","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/week-timeline","href":"/api-reference/v1/get-week-timeline"},{"title":"Get Focus Cards","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/focus-cards","href":"/api-reference/v1/get-focus-cards"}]},{"group":"Snapshots","pages":[{"title":"Start Snapshot","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/scans","href":"/api-reference/v1/start-snapshot"},{"title":"Edit Snapshot Profile","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/scans/{scan_id}/profile","href":"/api-reference/v1/edit-snapshot-profile"},{"title":"Run Snapshot","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/scans/{scan_id}/run","href":"/api-reference/v1/run-snapshot"},{"title":"Stop Snapshot","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/scans/{scan_id}/stop","href":"/api-reference/v1/stop-snapshot"},{"title":"Get Scan","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/scans/{scan_id}","href":"/api-reference/v1/get-scan"},{"title":"Get Account Scans","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/scans","href":"/api-reference/v1/get-account-scans"}]},{"group":"Visibility","pages":[{"title":"Get Scores","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/scores","href":"/api-reference/v1/get-scores"},{"title":"Get Perception","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/perception","href":"/api-reference/v1/get-perception"},{"title":"Get Perception Claim","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/perception/claims/{claim}","href":"/api-reference/v1/get-perception-claim"},{"title":"Get Moving Away From","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/moving-away-from","href":"/api-reference/v1/get-moving-away-from"},{"title":"Get Reputation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/reputation","href":"/api-reference/v1/get-reputation"},{"title":"Get Reputation Claim","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/reputation/claims/{claim}","href":"/api-reference/v1/get-reputation-claim"},{"title":"Get Reputation Opinion","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/reputation/opinions/{opinion_id}","href":"/api-reference/v1/get-reputation-opinion"},{"title":"Get Prompts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/prompts","href":"/api-reference/v1/get-prompts"},{"title":"Get Prompt","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/prompts/{prompt_uid}","href":"/api-reference/v1/get-prompt"},{"title":"Get Answers","description":"The engines' answers, newest first, optionally for one prompt, engine or named brand.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/answers","href":"/api-reference/v1/get-answers"},{"title":"Get Answer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/answers/{answer_id}","href":"/api-reference/v1/get-answer"},{"title":"Get Competitors","description":"The brand and its rivals, ranked by Heralded Score on AI or Mentioned on Search.\n\n`with_page` adds the competitor leaderboard and roster capacity.\n`with_details` also includes weekly sites, moves and stored AI descriptions.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/competitors","href":"/api-reference/v1/get-competitors"},{"title":"Get Competitor","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/competitors/{key}","href":"/api-reference/v1/get-competitor"},{"title":"Get Competitor Page","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/competitors/{key}/page","href":"/api-reference/v1/get-competitor-page"},{"title":"Get Sources","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/sources","href":"/api-reference/v1/get-sources"},{"title":"Get Source","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/sources/{domain}","href":"/api-reference/v1/get-source"},{"title":"Get Cited Pages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/cited-pages","href":"/api-reference/v1/get-cited-pages"},{"title":"Get Cited Page","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/cited-page","href":"/api-reference/v1/get-cited-page"},{"title":"Get Changes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/changes","href":"/api-reference/v1/get-changes"}]},{"group":"Site","pages":[{"title":"Get Pages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/pages","href":"/api-reference/v1/get-pages"},{"title":"Get Page","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/pages/{page_id}","href":"/api-reference/v1/get-page"},{"title":"Get Topics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/topics","href":"/api-reference/v1/get-topics"},{"title":"Get Topic","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/topics/{topic_id}","href":"/api-reference/v1/get-topic"},{"title":"Get Keywords","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/keywords","href":"/api-reference/v1/get-keywords"},{"title":"Get Keyword","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/keywords/{keyword_id}","href":"/api-reference/v1/get-keyword"},{"title":"Get Audit","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/audit","href":"/api-reference/v1/get-audit"},{"title":"Get Audit Map","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/audit/map","href":"/api-reference/v1/get-audit-map"}]},{"group":"Actions","pages":[{"title":"Get Actions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/actions","href":"/api-reference/v1/get-actions"},{"title":"Get Assets","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/assets","href":"/api-reference/v1/get-assets"},{"title":"Get Action","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/actions/{action_id}","href":"/api-reference/v1/get-action"},{"title":"Get Action Piece Image","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/actions/{action_id}/piece/images/{slot}","href":"/api-reference/v1/get-action-piece-image"},{"title":"Get Results","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/results","href":"/api-reference/v1/get-results"},{"title":"List Conversations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/conversations","href":"/api-reference/v1/list-conversations"},{"title":"Get Conversation By Id","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/conversations/{conversation_id}/messages","href":"/api-reference/v1/get-conversation-by-id"},{"title":"Get Conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/conversations/{member}","href":"/api-reference/v1/get-conversation"}]},{"group":"Settings and workspaces","pages":[{"title":"Get Free Snapshot","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/account/free-snapshot","href":"/api-reference/v1/get-free-snapshot"},{"title":"Get Brand Settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/settings","href":"/api-reference/v1/get-brand-settings"},{"title":"Get Strategy","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/strategy","href":"/api-reference/v1/get-strategy"},{"title":"Get Brand Markets","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/markets","href":"/api-reference/v1/get-brand-markets"},{"title":"Get Brand Audiences","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/audiences","href":"/api-reference/v1/get-brand-audiences"},{"title":"Get Organization Usage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/organizations/{organization_id}/usage","href":"/api-reference/v1/get-organization-usage"},{"title":"Get Organization Brands","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/organizations/{organization_id}/brands","href":"/api-reference/v1/get-organization-brands"}]}]}]},"basePath":"","title":"Get Answer - Heralded","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}