> ## Documentation Index > Fetch the complete documentation index at: https://docs.heralded.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get Brand Settings > Current profile, rivals, owned domains, autonomy, connection status and segments. ## OpenAPI ````yaml /api-reference/openapi.json get /v1/brands/{brand_id}/settings openapi: 3.1.0 info: description: >- Read-only access to one organization's brands, as the member who created the API key. Each key may make 120 requests a minute. Every error is an RFC 9457 problem (`application/problem+json`) whose `code` names it. summary: Read your brands' AI visibility in Heralded. title: Heralded API version: '1' servers: - url: https://api.heralded.ai security: [] paths: /v1/brands/{brand_id}/settings: get: tags: - v1 summary: Get Brand Settings description: >- Current profile, rivals, owned domains, autonomy, connection status and segments. operationId: getBrandSettings parameters: - in: path name: brand_id required: true schema: format: uuid title: Brand Id type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/V1Settings' description: Successful Response '400': 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: about:blank schema: $ref: '#/components/schemas/Problem' description: The cursor is invalid or belongs to a different query. '401': 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: about:blank schema: $ref: '#/components/schemas/Problem' description: No API key, or one that is unknown, revoked or expired. headers: WWW-Authenticate: schema: example: Bearer type: string '404': 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: about:blank schema: $ref: '#/components/schemas/Problem' description: No such brand or answer, or the key's owner cannot read it. '409': 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: about:blank schema: $ref: '#/components/schemas/Problem' description: The API key's organization is archived. '422': 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: about:blank schema: $ref: '#/components/schemas/ValidationProblem' description: A path or query parameter is invalid. '429': 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: about:blank schema: $ref: '#/components/schemas/RateLimitProblem' 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 security: - apiKey: [] components: schemas: V1Settings: properties: autonomy: $ref: '#/components/schemas/AutonomyPayload' brand_id: format: uuid title: Brand Id type: string connections: items: $ref: '#/components/schemas/V1ConnectionStatus' title: Connections type: array deletion_scheduled_for: anyOf: - type: string - type: 'null' title: Deletion Scheduled For description: anyOf: - type: string - type: 'null' title: Description domain: title: Domain type: string meta: $ref: '#/components/schemas/Meta' description: Normalized query and newest included scan. name: title: Name type: string owned_domains: $ref: '#/components/schemas/OwnedDomainsDraft' profile: $ref: '#/components/schemas/BrandProfilePage' prompts_reserved: anyOf: - type: integer - type: 'null' description: >- The brand's current prompt reservation; null when it shares the pool. title: Prompts Reserved prompts_used: description: >- Active prompts in the current prompt set, excluding retired segments. A paused brand keeps this count while spending no organization slots. title: Prompts Used type: integer segments: $ref: '#/components/schemas/V1Segments' required: - meta - brand_id - deletion_scheduled_for - name - domain - description - prompts_used - prompts_reserved - profile - owned_domains - autonomy - connections - segments title: V1Settings type: object Problem: description: |- An RFC 9457 problem. `type` is always `about:blank`, so `title` is the status's name, and `code` is what a client branches on. properties: code: title: Code type: string detail: title: Detail type: string instance: default: '' title: Instance type: string status: title: Status type: integer title: title: Title type: string type: const: about:blank default: about:blank title: Type type: string required: - type - title - status - detail - code - instance title: Problem type: object ValidationProblem: properties: code: title: Code type: string detail: title: Detail type: string errors: items: $ref: '#/components/schemas/ValidationIssue' title: Errors type: array instance: default: '' title: Instance type: string status: title: Status type: integer title: title: Title type: string type: const: about:blank default: about:blank title: Type type: string required: - type - title - status - detail - code - instance - errors title: ValidationProblem type: object RateLimitProblem: properties: code: title: Code type: string detail: title: Detail type: string instance: default: '' title: Instance type: string rate_limit: $ref: '#/components/schemas/RateLimitValues' status: title: Status type: integer title: title: Title type: string type: const: about:blank default: about:blank title: Type type: string required: - type - title - status - detail - code - instance - rate_limit title: RateLimitProblem type: object AutonomyPayload: description: |- A brand's Autonomy as the page draws it: the two switches, the preset, the 3 x 4 grid, and what the plan locks. properties: areas: items: $ref: '#/components/schemas/AutonomyAreaRow' title: Areas type: array locked: items: enum: - picks_up_work - runs_steps - skips_draft_approval - acts_without_asking type: string title: Locked type: array locked_presets: items: enum: - autopilot - delegate - ask_first - manual - custom type: string title: Locked Presets type: array preset: enum: - autopilot - delegate - ask_first - manual - custom title: Preset type: string read_only: anyOf: - $ref: '#/components/schemas/AutonomyReadOnly' - type: 'null' simple: anyOf: - $ref: '#/components/schemas/AutonomySimple' - type: 'null' site_fixes_executor: title: Site Fixes Executor type: boolean required: - preset - locked - locked_presets - areas - read_only - simple - site_fixes_executor title: AutonomyPayload type: object V1ConnectionStatus: properties: available: title: Available type: boolean detail: additionalProperties: type: string title: Detail type: object notification_rules: additionalProperties: type: boolean title: Notification Rules type: object provider: title: Provider type: string reauthorise_from: anyOf: - type: string - type: 'null' title: Reauthorise From reauthorise_token_ended: default: true title: Reauthorise Token Ended type: boolean state: enum: - connected - needs_property - degraded - reconnect_required - reauthorise - disconnected title: State type: string required: - provider - state - available - reauthorise_from - reauthorise_token_ended - detail - notification_rules title: V1ConnectionStatus type: object Meta: properties: data_as_of: anyOf: - $ref: '#/components/schemas/DataAsOf' - type: 'null' query: additionalProperties: $ref: '#/components/schemas/JsonValue' title: Query type: object required: - query - data_as_of title: Meta type: object OwnedDomainsDraft: description: The review gate over which domains count as this brand's own. properties: confirmed: anyOf: - items: type: string type: array - type: 'null' title: Confirmed derived: items: type: string title: Derived type: array dismissed: default: [] items: type: string title: Dismissed type: array proposed: items: type: string title: Proposed type: array required: - derived - proposed - confirmed - dismissed title: OwnedDomainsDraft type: object BrandProfilePage: description: |- The configuration page, whole. No band and no score: nothing here is a measurement, and everything here decides one. properties: alias_limit: title: Alias Limit type: integer aliases: items: $ref: '#/components/schemas/AliasRow' title: Aliases type: array claims: items: $ref: '#/components/schemas/ProfileClaim' title: Claims type: array countries: additionalProperties: type: string title: Countries type: object country_languages: additionalProperties: type: string title: Country Languages type: object domain: title: Domain type: string domain_id: title: Domain Id type: string edited_at: anyOf: - type: string - type: 'null' title: Edited At fact_limit: default: 20 title: Fact Limit type: integer facts: items: $ref: '#/components/schemas/BrandFact' title: Facts type: array languages: additionalProperties: type: string title: Languages type: object personas: items: $ref: '#/components/schemas/PersonaBox' title: Personas type: array profile: $ref: '#/components/schemas/BrandProfile' rival_cap: anyOf: - type: integer - type: 'null' title: Rival Cap rivals: items: $ref: '#/components/schemas/RivalTag' title: Rivals type: array required: - domain_id - domain - profile - countries - languages - country_languages - edited_at - claims - facts - fact_limit - aliases - alias_limit - rivals - rival_cap - personas title: BrandProfilePage type: object V1Segments: properties: comparison: anyOf: - $ref: '#/components/schemas/SegmentsTable' - type: 'null' meta: $ref: '#/components/schemas/Meta' description: Normalized query and newest included scan. personas: items: $ref: '#/components/schemas/PersonaRow' title: Personas type: array segment_limit: title: Segment Limit type: integer segment_limit_note: anyOf: - type: string - type: 'null' title: Segment Limit Note segments: items: $ref: '#/components/schemas/SegmentRow' title: Segments type: array vocabulary: $ref: '#/components/schemas/SegmentVocabulary' required: - meta - segments - personas - vocabulary - segment_limit - segment_limit_note - comparison title: V1Segments type: object ValidationIssue: properties: loc: items: anyOf: - type: string - type: integer title: Loc type: array msg: title: Msg type: string type: title: Type type: string required: - loc - msg - type title: ValidationIssue type: object RateLimitValues: properties: limit: title: Limit type: integer remaining: title: Remaining type: integer reset: title: Reset type: integer window: title: Window type: integer required: - limit - window - remaining - reset title: RateLimitValues type: object AutonomyAreaRow: description: |- One area of work on the Autonomy page: what is stored, which cells the grid disables, and the area's extras. properties: area: enum: - website - content - outreach title: Area type: string outreach: anyOf: - $ref: '#/components/schemas/OutreachLimitResponse' - type: 'null' refusal: anyOf: - type: string - type: 'null' title: Refusal suspended: title: Suspended type: boolean switches: $ref: '#/components/schemas/AutonomySwitches' unavailable: items: enum: - picks_up_work - runs_steps - skips_draft_approval - acts_without_asking type: string title: Unavailable type: array required: - area - switches - unavailable - suspended - refusal - outreach title: AutonomyAreaRow type: object AutonomyReadOnly: description: |- Why the plan refuses Autonomy writes, so the page disables the controls and says so rather than meeting 402 `no_plan` on a click. properties: message: title: Message type: string reason: enum: - canceled - grace_lapsed - archived - no_plan title: Reason type: string until: anyOf: - format: date-time type: string - type: 'null' title: Until required: - reason - until - message title: AutonomyReadOnly type: object AutonomySimple: description: |- The two switches the Autonomy page opens on (#3295). Each combination writes the grid `SWITCHES_BY_SIMPLE` names. properties: ask_before_leaving: title: Ask Before Leaving type: boolean auto_site_fixes: title: Auto Site Fixes type: boolean required: - ask_before_leaving - auto_site_fixes title: AutonomySimple type: object DataAsOf: properties: completed_at: format: date-time title: Completed At type: string id: format: uuid title: Id type: string required: - id - completed_at title: DataAsOf type: object JsonValue: {} AliasRow: description: |- One name that counts as a mention. `source` says where it came from: `name` is the brand's own name, `product` one of its product lines and `domain` the registrable label of its site, all derived and none removable here; `profile` is one somebody added. properties: name: title: Name type: string removable: title: Removable type: boolean source: enum: - name - profile - product - domain title: Source type: string required: - name - source - removable title: AliasRow type: object ProfileClaim: description: One claim, as the profile states it and as the engines read it back. properties: absent: title: Absent type: integer agrees: title: Agrees type: integer ai_reads: anyOf: - type: string - type: 'null' title: Ai Reads answers: title: Answers type: integer axis: title: Axis type: string diverges: title: Diverges type: integer engines: title: Engines type: integer field: title: Field type: string intended: anyOf: - type: string - type: 'null' title: Intended label: title: Label type: string measured: anyOf: - type: string - type: 'null' title: Measured partial: title: Partial type: integer score: anyOf: - type: number - type: 'null' title: Score required: - axis - label - field - intended - measured - ai_reads - score - answers - engines - agrees - partial - diverges - absent title: ProfileClaim type: object BrandFact: properties: added_at: format: date-time title: Added At type: string added_by: format: uuid title: Added By type: string id: format: uuid title: Id type: string statement: maxLength: 300 minLength: 1 title: Statement type: string updated_at: format: date-time title: Updated At type: string version: minimum: 1 title: Version type: integer required: - id - statement - version - added_by - added_at - updated_at title: BrandFact type: object PersonaBox: description: >- One asker, and the segments that ask as it. `id` is None on the general buyer, which is the absence of a persona rather than a row in the library (D47), so it carries no fields and cannot be edited or removed. properties: ai_generated: title: Ai Generated type: boolean audience_type: anyOf: - type: string - type: 'null' title: Audience Type description: anyOf: - type: string - type: 'null' title: Description fields: additionalProperties: true title: Fields type: object id: anyOf: - type: string - type: 'null' title: Id is_general_buyer: title: Is General Buyer type: boolean name: title: Name type: string segments: items: $ref: '#/components/schemas/PersonaSegmentRow' title: Segments type: array shift: anyOf: - type: string - type: 'null' title: Shift required: - id - name - description - audience_type - fields - ai_generated - is_general_buyer - segments - shift title: PersonaBox type: object BrandProfile: properties: aliases: items: type: string title: Aliases type: array audience: anyOf: - type: string - type: 'null' title: Audience category: anyOf: - type: string - type: 'null' title: Category country: anyOf: - type: string - type: 'null' title: Country differentiators: anyOf: - type: string - type: 'null' title: Differentiators language: anyOf: - type: string - type: 'null' title: Language measured_product_line: anyOf: - type: string - type: 'null' title: Measured Product Line offering: anyOf: - type: string - type: 'null' title: Offering product_lines: items: $ref: '#/components/schemas/ProductLineView' title: Product Lines type: array required: - category - audience - offering - differentiators - country - language - product_lines - measured_product_line - aliases title: BrandProfile type: object RivalTag: properties: brand_key: title: Brand Key type: string brand_name: title: Brand Name type: string source: title: Source type: string status: title: Status type: string required: - brand_key - brand_name - status - source title: RivalTag type: object SegmentsTable: properties: rows: items: $ref: '#/components/schemas/SegmentTableRow' title: Rows type: array total: default: 0 title: Total type: integer required: - rows - total title: SegmentsTable type: object PersonaRow: properties: ai_generated: title: Ai Generated type: boolean audience_type: title: Audience Type type: string description: title: Description type: string fields: additionalProperties: true title: Fields type: object id: format: uuid title: Id type: string name: title: Name type: string required: - id - name - description - audience_type - fields - ai_generated title: PersonaRow type: object SegmentRow: properties: config_version: anyOf: - type: integer - type: 'null' title: Config Version country: anyOf: - type: string - type: 'null' title: Country engine_selection: anyOf: - items: type: string type: array - type: 'null' title: Engine Selection engine_vocabulary: items: $ref: '#/components/schemas/EngineVocabulary' title: Engine Vocabulary type: array engines: items: type: string title: Engines type: array id: format: uuid title: Id type: string is_default: title: Is Default type: boolean label: title: Label type: string language: title: Language type: string name: title: Name type: string persona_id: anyOf: - format: uuid type: string - type: 'null' title: Persona Id prompt_count: default: 0 title: Prompt Count type: integer retired: title: Retired type: boolean subregion: anyOf: - type: string - type: 'null' title: Subregion required: - engine_vocabulary - id - label - name - persona_id - language - country - subregion - engine_selection - engines - is_default - retired - config_version - prompt_count title: SegmentRow type: object SegmentVocabulary: properties: languages: additionalProperties: type: string title: Languages type: object markets: additionalProperties: type: string title: Markets type: object optional_engines: items: type: string title: Optional Engines type: array standard_engines: items: type: string title: Standard Engines type: array subregions: additionalProperties: additionalProperties: type: string type: object title: Subregions type: object required: - markets - subregions - languages - standard_engines - optional_engines title: SegmentVocabulary type: object OutreachLimitResponse: properties: routes: default: [] items: $ref: '#/components/schemas/OutreachRouteRow' title: Routes type: array required: - routes title: OutreachLimitResponse type: object AutonomySwitches: additionalProperties: false description: One area's four switches, each a rung of one ladder (D16). properties: acts_without_asking: title: Acts Without Asking type: boolean picks_up_work: title: Picks Up Work type: boolean runs_steps: title: Runs Steps type: boolean skips_draft_approval: title: Skips Draft Approval type: boolean required: - picks_up_work - runs_steps - skips_draft_approval - acts_without_asking title: AutonomySwitches type: object PersonaSegmentRow: properties: id: title: Id type: string is_default: title: Is Default type: boolean label: title: Label type: string name: title: Name type: string required: - id - label - name - is_default title: PersonaSegmentRow type: object ProductLineView: properties: category: title: Category type: string name: title: Name type: string target_buyer: anyOf: - type: string - type: 'null' title: Target Buyer required: - name - category - target_buyer title: ProductLineView type: object SegmentTableRow: description: One row of the comparison table (SU-4). properties: axes: items: $ref: '#/components/schemas/SegmentAxis' title: Axes type: array chips: $ref: '#/components/schemas/SegmentChips' is_default: title: Is Default type: boolean label: title: Label type: string name: title: Name type: string prompt_count: title: Prompt Count type: integer retired: title: Retired type: boolean score: anyOf: - type: integer - type: 'null' title: Score score_change: anyOf: - $ref: '#/components/schemas/PairedChange' - type: 'null' segment_id: title: Segment Id type: string required: - segment_id - label - name - is_default - retired - chips - prompt_count - score - score_change - axes title: SegmentTableRow type: object EngineVocabulary: properties: display_name: title: Display Name type: string engine_id: title: Engine Id type: string sort_order: title: Sort Order type: integer required: - engine_id - display_name - sort_order title: EngineVocabulary type: object OutreachRouteRow: description: One outreach route's switch and limit (#3125). properties: choices: items: type: integer title: Choices type: array enabled: title: Enabled type: boolean label: title: Label type: string limit: title: Limit type: integer route: enum: - pitch - listing - partnership - community title: Route type: string required: - route - label - enabled - limit - choices title: OutreachRouteRow type: object SegmentAxis: description: |- One axis of one segment over the last week, with its move beside it. `value` is `null` where the week could not measure the axis, which is a gap. `change` is the figures read's paired change over the segment's answers, and is `null` where no earlier week read them: a first read has moved from nothing. properties: axis: title: Axis type: string change: anyOf: - $ref: '#/components/schemas/PairedChange' - type: 'null' label: title: Label type: string population: title: Population type: string value: anyOf: - type: integer - type: 'null' title: Value required: - axis - label - population - value - change title: SegmentAxis type: object SegmentChips: description: >- The three dimensions a segment fixes, as the row and the pane head draw them. `claude` is the fourth chip and only appears once a segment adds it (SU-12). properties: claude: default: false title: Claude type: boolean language: title: Language type: string market: title: Market type: string persona: title: Persona type: string required: - market - language - persona - claude title: SegmentChips type: object PairedChange: description: |- A figure's change over the selected window, in points, with its 95% range (`app.scans.scoring.axes.change_payload`). `real` is whether the paired test over the prompt × engine cells both reads measured says it moved; a surface announces only a real change. properties: delta: title: Delta type: number high: title: High type: number low: title: Low type: number real: title: Real type: boolean required: - delta - low - high - real title: PairedChange type: object securitySchemes: apiKey: description: 'An API key, sent as `Authorization: Bearer hrld_...`.' scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.