> ## 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 Answer > One answer in full, with the pages it cited and the rivals it named. ## OpenAPI ````yaml /api-reference/openapi.json get /v1/brands/{brand_id}/answers/{answer_id} 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}/answers/{answer_id}: get: tags: - v1 summary: Get Answer description: One answer in full, with the pages it cited and the rivals it named. operationId: getAnswer parameters: - in: path name: brand_id required: true schema: format: uuid title: Brand Id type: string - in: path name: answer_id required: true schema: format: uuid title: Answer Id type: string - description: Include only scans up to this completed scan id. in: query name: as_of required: false schema: anyOf: - format: uuid type: string - type: 'null' description: Include only scans up to this completed scan id. title: As Of responses: '200': content: application/json: schema: $ref: '#/components/schemas/V1Answer' 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: V1Answer: examples: - cited_urls: - https://example.com/best-agency-crm engine: openai excerpt: For agencies, Acme and Rival lead... id: 5d2e8c1f-7a3b-4c6d-9e0f-1a2b3c4d5e6f mentioned: true prompt: best crm for agencies prompt_id: 0b8e5f7a-2c4d-4e6f-8a1b-3c5d7e9f1a2b read_at: '2026-09-22T09:00:00Z' recommended: true rivals_named: - Rival segment: Agencies text: For agencies, Acme and Rival lead the field. properties: also_named: items: $ref: '#/components/schemas/NamedAnswerBrand' title: Also Named type: array cited_page_count: default: 0 title: Cited Page Count type: integer cited_pages: items: $ref: '#/components/schemas/CitedPage' title: Cited Pages type: array cited_urls: items: type: string title: Cited Urls type: array engine: enum: - perplexity - gemini - openai - google_aio - ai_mode - copilot - claude title: Engine type: string engine_vocabulary: items: $ref: '#/components/schemas/EngineVocabulary' title: Engine Vocabulary type: array excerpt: title: Excerpt type: string excerpt_highlights: items: $ref: '#/components/schemas/AnswerHighlightSpan' title: Excerpt Highlights type: array highlights: items: $ref: '#/components/schemas/AnswerHighlightSpan' title: Highlights type: array id: format: uuid title: Id type: string mentioned: anyOf: - type: boolean - type: 'null' title: Mentioned meta: $ref: '#/components/schemas/Meta' description: Normalized query and newest included scan. own_cited_page_count: default: 0 title: Own Cited Page Count type: integer prompt: title: Prompt type: string prompt_id: format: uuid title: Prompt Id type: string read_at: format: date-time title: Read At type: string recommended: anyOf: - type: boolean - type: 'null' title: Recommended rival_brands: items: type: string title: Rival Brands type: array rivals_named: items: type: string title: Rivals Named type: array run_class: anyOf: - type: string - type: 'null' title: Run Class run_number: anyOf: - type: integer - type: 'null' title: Run Number segment: title: Segment type: string segment_config_version: anyOf: - type: integer - type: 'null' title: Segment Config Version segment_detail: anyOf: - $ref: '#/components/schemas/AnswerReadSegment' - type: 'null' states: $ref: '#/components/schemas/AnswerReadStates' subject_brand: anyOf: - type: string - type: 'null' title: Subject Brand text: title: Text type: string text_retained: default: true title: Text Retained type: boolean required: - meta - 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 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 NamedAnswerBrand: properties: domain: anyOf: - type: string - type: 'null' title: Domain name: title: Name type: string tracked: default: false title: Tracked type: boolean required: - name - domain - tracked title: NamedAnswerBrand type: object CitedPage: properties: document_key: title: Document Key type: string domain: title: Domain type: string title: anyOf: - type: string - type: 'null' title: Title url: title: Url type: string required: - url - document_key - title - domain title: CitedPage 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 AnswerHighlightSpan: description: |- One place the answer names the brand or a rival, for the overlay to mark: half-open offsets into `answer_text`, counted in Unicode code points, with `you` for the brand's own names and `rival` for a rival's. properties: brand: enum: - you - rival title: Brand type: string end: minimum: 0 title: End type: integer start: minimum: 0 title: Start type: integer required: - start - end - brand title: AnswerHighlightSpan 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 AnswerReadSegment: properties: geo: title: Geo type: string label: title: Label type: string persona_id: title: Persona Id type: string required: - label - persona_id - geo title: AnswerReadSegment type: object AnswerReadStates: description: >- 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. properties: icon_states: $ref: '#/components/schemas/IconStates' readOnly: true mentioned: anyOf: - type: boolean - type: 'null' title: Mentioned praised: anyOf: - type: boolean - type: 'null' title: Praised recommended: anyOf: - type: boolean - type: 'null' title: Recommended understood: anyOf: - type: number - type: 'null' title: Understood required: - mentioned - understood - recommended - praised - icon_states title: AnswerReadStates 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 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: {} IconStates: description: Each axis as the icon a row draws for it. properties: mentioned: enum: - 'yes' - partial - 'no' - not_measured title: Mentioned type: string praised: enum: - 'yes' - partial - 'no' - not_measured title: Praised type: string recommended: enum: - 'yes' - partial - 'no' - not_measured title: Recommended type: string understood: enum: - 'yes' - partial - 'no' - not_measured title: Understood type: string required: - mentioned - understood - recommended - praised title: IconStates 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.