> ## Documentation Index
> Fetch the complete documentation index at: https://docs.surfacd.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Response

> Full detail for a single AI response: the response record, its prompt (with target country), the platform, cited sources, and any brand mentions.



## OpenAPI

````yaml /openapi.json get /api/v1/projects/{project}/reputation/responses/{response}
openapi: 3.1.0
info:
  title: Surfacd Public API
  version: 1.0.0
  description: >-
    Public API for Surfacd. Team-scoped operations live under
    `/api/v1/team/...`; project collections live under `/api/v1/projects`;
    project-scoped operations live under `/api/v1/projects/{project}/...`. All
    endpoints require a Bearer team API key created in Team Settings. The API
    key selects the team for team-level and collection endpoints.
servers:
  - url: https://app.surfacd.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Projects
    description: Project management endpoints. Reads only in this version.
  - name: Prompts
    description: Prompt management endpoints. Reads only in this version.
  - name: Team
    description: Team settings and plan details for the current team.
  - name: Reporting
    description: >-
      Read-only reporting endpoints for projects (brand rankings, mentions,
      visibility, matrix analysis, source data).
  - name: Reference
    description: Reference data used by create, update, and reporting filters.
  - name: Tags
    description: Project tag management endpoints.
  - name: Reputation
    description: >-
      Read-only reputation analytics for a project: sentiment overview and
      trends, themes, narratives, the AI responses behind them, and the sources
      those responses cite. Requires the Reputation capability on the project's
      team; without it these endpoints return `403`.
paths:
  /api/v1/projects/{project}/reputation/responses/{response}:
    parameters:
      - $ref: '#/components/parameters/ProjectUuid'
      - $ref: '#/components/parameters/ResponseUuid'
    get:
      tags:
        - Reputation
      summary: Get Response
      description: >-
        Full detail for a single AI response: the response record, its prompt
        (with target country), the platform, cited sources, and any brand
        mentions.
      operationId: v1ProjectsReputationResponsesShow
      responses:
        '200':
          description: The response detail.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseDetail'
        '403':
          $ref: '#/components/responses/ReputationNotEnabled'
        '404':
          description: Response not found in this project.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                required:
                  - message
components:
  parameters:
    ProjectUuid:
      name: project
      in: path
      required: true
      description: Project UUID.
      schema:
        type: string
        format: uuid
    ResponseUuid:
      name: response
      in: path
      required: true
      description: >-
        The AI response UUID. Scoped to the project's responses; a foreign UUID
        returns 404.
      schema:
        type: string
        format: uuid
  schemas:
    ResponseDetail:
      type: object
      description: >-
        Full detail for a single AI response behind a reputation mention: the
        response record, its prompt (with target country), the platform, the
        cited sources, and any brand mentions.
      properties:
        prompt_response:
          $ref: '#/components/schemas/ReputationResponsePromptResponse'
        prompt:
          $ref: '#/components/schemas/ReputationResponsePrompt'
        service:
          $ref: '#/components/schemas/ReputationResponseService'
        sources:
          type: array
          items:
            $ref: '#/components/schemas/ReputationResponseSource'
        brand_mentions:
          type: array
          items:
            $ref: '#/components/schemas/BrandMention'
        fan_out_queries:
          type: array
          items:
            $ref: '#/components/schemas/FanOutQuery'
          description: >-
            Web searches the platform ran before answering. Empty for platforms
            that answer from knowledge alone.
      required:
        - prompt_response
        - prompt
        - service
        - sources
        - brand_mentions
        - fan_out_queries
    ReputationResponsePromptResponse:
      type: object
      description: The raw AI response record behind a reputation mention.
      properties:
        uuid:
          type: string
          format: uuid
        response_text:
          type: string
        response_metadata:
          type:
            - object
            - 'null'
        checked_at:
          type: string
          format: date-time
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        prompt:
          oneOf:
            - $ref: '#/components/schemas/ReputationResponsePrompt'
            - type: 'null'
        service:
          oneOf:
            - $ref: '#/components/schemas/ReputationResponseService'
            - type: 'null'
      required:
        - uuid
        - response_text
        - checked_at
        - created_at
        - updated_at
    ReputationResponsePrompt:
      type: object
      description: The prompt behind a reputation response, with its target country.
      properties:
        uuid:
          type: string
          format: uuid
        keyword:
          type:
            - string
            - 'null'
        prompt_text:
          type: string
        search_volume:
          type:
            - integer
            - 'null'
        status:
          type: integer
          description: >-
            Prompt status: `0` Suggestion, `1` Declined, `2` Inactive, `3`
            Active.
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        deleted_at:
          type:
            - string
            - 'null'
          format: date-time
        brand_visibility:
          type:
            - number
            - 'null'
          format: float
        search_volume_level:
          type:
            - integer
            - 'null'
        is_volume_hydrated:
          type: boolean
        project:
          type: 'null'
        topic:
          type:
            - object
            - 'null'
        country:
          oneOf:
            - $ref: '#/components/schemas/ReputationResponseCountry'
            - type: 'null'
        tags:
          type:
            - array
            - 'null'
          items:
            type: object
      required:
        - uuid
        - prompt_text
        - status
        - created_at
        - updated_at
        - is_volume_hydrated
    ReputationResponseService:
      type: object
      description: The AI platform that produced a reputation response.
      properties:
        uuid:
          type: string
          format: uuid
        provider:
          type: string
        name:
          type: string
        display_name:
          type: string
        is_active:
          type: boolean
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
        - uuid
        - provider
        - name
        - display_name
        - is_active
        - created_at
        - updated_at
    ReputationResponseSource:
      type: object
      description: A source URL cited by an AI response.
      properties:
        url:
          type: string
        domain:
          type: string
        hostname:
          type: string
        title:
          type:
            - string
            - 'null'
        rank:
          type: integer
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
        - url
        - domain
        - hostname
        - rank
        - created_at
        - updated_at
    BrandMention:
      type: object
      description: >-
        Public brand mention representation. Internal numeric IDs are not
        exposed; nested related objects use public UUIDs or provider/country
        identifiers where present.
      properties:
        sentiment:
          type: string
          description: '`positive`, `negative`, or `neutral`.'
        salience_score:
          type: string
          description: Returned as a string for precision; parse to float on the client.
        rank:
          type: integer
        mention_snippet:
          type:
            - string
            - 'null'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
        - sentiment
        - salience_score
        - rank
        - mention_snippet
        - created_at
        - updated_at
    FanOutQuery:
      type: object
      description: >-
        One web search the AI platform ran while building the answer. Listed in
        the order the platform issued them.
      properties:
        query:
          type: string
          description: >-
            The search text as issued, including any operators such as site: or
            quoted phrases.
        rank:
          type: integer
          description: 1-based position in the order the platform ran its searches.
      required:
        - query
        - rank
    ReputationResponseCountry:
      type: object
      description: The target country of the prompt behind a reputation response.
      properties:
        code:
          type: string
        name:
          type: string
        is_active:
          type: boolean
        primary_language:
          type:
            - string
            - 'null'
        flag:
          type: string
      required:
        - code
        - name
        - is_active
        - flag
  responses:
    ReputationNotEnabled:
      description: >-
        Reputation is not available: the team's plan does not include the
        Reputation capability, or the project has not enabled it.
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
            required:
              - message
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: token
      description: >-
        Team API key created in Team Settings. Use it with URLs for the same
        team.

````