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

# Get response

> One answer in full: the row from List responses, the whole answer as Markdown, every page the model cited or consulted, every competitor it named, every domain it recommended with its position, and any shopping tiles it showed.

This is the prompt page detail for one answer, in one call.

Cost: 2 API credits.

Needs: Read.




## OpenAPI

````yaml /openapi.yaml get /projects/{project}/responses/{response}
openapi: 3.1.0
info:
  title: Radarkit API
  version: 1.0.0
  summary: Your AI visibility data, outside the dashboard.
  description: >
    Radarkit tracks how AI assistants answer the questions your customers ask,
    and what each answer says about your brand. This API gives you that data as
    JSON.


    Every request needs an API key in the `Authorization` header. Every response
    has the same shape: `data`, `meta`, `credits` and `request_id`. Most calls
    cost 1 API credit. Heavier calls cost 2. Exports spend Export rows instead,
    one per row.
  contact:
    name: Radarkit support
    email: mail@radarkit.ai
    url: https://radarkit.ai
servers:
  - url: https://api.radarkit.ai/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Account
    description: Your key, your plan and both balances. Free.
  - name: Projects
    description: One project is one brand or website. Every other call needs a project id.
  - name: Topics
    description: Topics group prompts. Every prompt belongs to one topic.
  - name: Prompts
    description: The questions Radarkit asks every AI model on a schedule.
  - name: Visibility
    description: The daily visibility score per model, precomputed.
  - name: Responses
    description: One row per AI answer, with everything Radarkit found in it.
  - name: Sources
    description: The web pages AI answers cite or consult.
  - name: Competitors
    description: Who the answers recommend and how often.
  - name: Rankings
    description: Recommended domains with their position in the answer.
  - name: Query fanout
    description: The web searches a model ran before answering, one row per answer.
  - name: Web search
    description: How often the models searched and what they searched for, summarised.
  - name: Sentiment
    description: How the answers talk about your brand.
  - name: Exports
    description: >
      Thousands of rows as one gzip file. Four calls in order: estimate, create,
      poll, download.


      Estimate is free and returns the exact row count. Create charges that many
      Export rows and queues the job. Poll the export until its status is
      `ready`. Download follows a redirect to a signed link that works for 30
      minutes. Files are kept for 7 days.
  - name: Content
    description: Have the Content agent write an article for a prompt, then poll the run.
paths:
  /projects/{project}/responses/{response}:
    get:
      tags:
        - Responses
      summary: Get response
      description: >
        One answer in full: the row from List responses, the whole answer as
        Markdown, every page the model cited or consulted, every competitor it
        named, every domain it recommended with its position, and any shopping
        tiles it showed.


        This is the prompt page detail for one answer, in one call.


        Cost: 2 API credits.


        Needs: Read.
      operationId: getResponse
      parameters:
        - $ref: '#/components/parameters/project'
        - name: response
          in: path
          required: true
          description: The response id. From List responses.
          schema:
            type: integer
      responses:
        '200':
          description: The answer with everything found in it.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ResponseDetail'
                  meta:
                    type: object
                    properties:
                      project:
                        type: string
                      timezone:
                        type: string
                  credits:
                    $ref: '#/components/schemas/Credits'
                  request_id:
                    $ref: '#/components/schemas/RequestId'
              example:
                data:
                  id: 918273
                  prompt:
                    id: 2048
                    text: best crm for a startup
                  model: chatgpt
                  date: '2026-08-31'
                  collected_at: '2026-08-31T03:12:40+00:00'
                  brand_mentioned: true
                  position: top
                  sentiment: positive
                  search_performed: true
                  search_queries:
                    - best crm startups 2026
                  competitors_count: 2
                  realtime: false
                  content_markdown: >-
                    For a startup, the strongest picks right now are:


                    - **Acme CRM** for teams under 20 [1]

                    - HubSpot when you need marketing tools in the same place
                    [2]
                  sources:
                    - url: https://www.acme.com/pricing
                      domain: acme.com
                      cited: true
                      cite_rank: 1
                    - url: https://www.hubspot.com/products/crm
                      domain: hubspot.com
                      cited: true
                      cite_rank: 2
                    - url: https://www.g2.com/categories/crm
                      domain: g2.com
                      cited: false
                      cite_rank: null
                  competitors:
                    - domain: hubspot.com
                      url: https://www.hubspot.com/products/crm
                    - domain: pipedrive.com
                      url: https://www.pipedrive.com
                  rankings:
                    - domain: acme.com
                      url: https://www.acme.com
                      position: 1
                    - domain: hubspot.com
                      url: https://www.hubspot.com
                      position: 2
                  products: []
                meta:
                  project: 64f1a2b3c4d5e6f708192a3b
                  timezone: America/New_York
                credits:
                  charged: 2
                  remaining: 2943
                request_id: req_01j9x4v9l0m1n2o3p4q5r6s7t9
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: >-
            `PROJECT_NOT_FOUND`: no project with that id. `NOT_FOUND`: no
            response with that id in this project.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          $ref: '#/components/responses/RateLimited'
        '504':
          $ref: '#/components/responses/QueryTimeout'
components:
  parameters:
    project:
      name: project
      in: path
      required: true
      description: The project id. 24 characters. From List projects.
      schema:
        type: string
        pattern: ^[0-9a-f]{24}$
      example: 64f1a2b3c4d5e6f708192a3b
  schemas:
    ResponseDetail:
      allOf:
        - $ref: '#/components/schemas/Response'
        - type: object
          properties:
            content_markdown:
              type: string
              description: The whole answer as Markdown with a numbered source list.
            sources:
              type: array
              items:
                type: object
                properties:
                  url:
                    type: string
                  domain:
                    type:
                      - string
                      - 'null'
                  cited:
                    type:
                      - boolean
                      - 'null'
                  cite_rank:
                    type:
                      - integer
                      - 'null'
            competitors:
              type: array
              items:
                type: object
                properties:
                  domain:
                    type:
                      - string
                      - 'null'
                  url:
                    type: string
            rankings:
              type: array
              items:
                type: object
                properties:
                  domain:
                    type:
                      - string
                      - 'null'
                  url:
                    type: string
                  position:
                    type:
                      - integer
                      - 'null'
            products:
              type: array
              description: Shopping tiles, when the answer showed any.
              items:
                type: object
                properties:
                  name:
                    type: string
                  merchant:
                    type:
                      - string
                      - 'null'
                  merchant_domain:
                    type:
                      - string
                      - 'null'
                  url:
                    type:
                      - string
                      - 'null'
                  price:
                    type:
                      - string
                      - 'null'
                  group:
                    type: integer
                  position:
                    type: integer
    Credits:
      type: object
      description: >-
        What this call cost and what is left. Also in the
        `X-RadarKit-Credits-Charged` and `X-RadarKit-Credits-Remaining` headers.
      properties:
        charged:
          type: integer
          description: API credits spent on this call.
        remaining:
          type:
            - integer
            - 'null'
          description: API credits left on the billed account. Null on free calls.
    RequestId:
      type: string
      description: >-
        A unique id for this call. Also in the `X-Request-Id` header. Quote it
        when you contact support.
      example: req_01j9x4m2p7q8r9s0t1u2v3w4x5
    Error:
      type: object
      description: Every failed call has this shape and no `data`.
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: Stable. Build on this, not on the message.
            message:
              type: string
              description: For people. May change.
            details:
              description: >-
                More when there is more to say. Which field failed, how long to
                wait, which id already exists.
              oneOf:
                - type: object
                - type: array
                  items:
                    type: object
        request_id:
          $ref: '#/components/schemas/RequestId'
    Response:
      type: object
      properties:
        id:
          type: integer
        prompt:
          type: object
          properties:
            id:
              type: integer
            text:
              type:
                - string
                - 'null'
        model:
          type: string
        date:
          type: string
          format: date
          description: The day the answer was collected, as the dashboard groups it.
        collected_at:
          type: string
          format: date-time
          description: The exact moment, in UTC.
        brand_mentioned:
          type:
            - boolean
            - 'null'
        position:
          type:
            - string
            - 'null'
          enum:
            - top
            - middle
            - bottom
            - null
          description: Where the brand appeared.
        sentiment:
          type:
            - string
            - 'null'
          enum:
            - positive
            - mixed
            - negative
            - null
        search_performed:
          type:
            - boolean
            - 'null'
          description: True when the model searched the web before answering.
        search_queries:
          type: array
          items:
            type: string
        competitors_count:
          type: integer
        realtime:
          type:
            - boolean
            - 'null'
          description: True when the answer came from Run a prompt now, not the schedule.
        content_markdown:
          type: string
          description: The answer as Markdown. Only with `include=content`.
  responses:
    Unauthenticated:
      description: >-
        `UNAUTHENTICATED`: no key, a wrong key, or a revoked or expired key.
        `KEY_IN_QUERY` (400) if the key was in the URL.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: UNAUTHENTICATED
              message: >-
                Missing or invalid API key. Send it as: Authorization: Bearer
                rk_live_YOUR_KEY
            request_id: req_01j9x4q7z8y9x0w1v2u3t4s5r6
    PaymentRequired:
      description: >-
        `INSUFFICIENT_CREDITS`: no API credits left, nothing ran.
        `PLAN_INACTIVE`: the key owner's plan is not active.
        `OWNER_PLAN_INACTIVE`: the project owner's plan is not active.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INSUFFICIENT_CREDITS
              message: Not enough API credits.
            request_id: req_01j9x4q7z8y9x0w1v2u3t4s5r7
    Forbidden:
      description: >-
        `SCOPE_MISSING`: the key lacks the permission this call needs.
        `PROJECT_FORBIDDEN`: the key cannot reach this project. `API_FROZEN`:
        API access for the account is paused.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: PROJECT_FORBIDDEN
              message: This key cannot access that project.
            request_id: req_01j9x4q7z8y9x0w1v2u3t4s5r9
    RateLimited:
      description: >-
        `RATE_LIMITED`: too many calls. Wait the seconds in `Retry-After` and
        send the same request again. Nothing was charged.
      headers:
        Retry-After:
          description: Seconds to wait.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: RATE_LIMITED
              message: Too many requests. Slow down and retry.
              details:
                retry_after: 21
            request_id: req_01j9x4r2s3t4u5v6w7x8y9z0a1
    QueryTimeout:
      description: >-
        `QUERY_TIMEOUT`: the query took too long. Nothing was charged. Narrow
        the range or create an export.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: QUERY_TIMEOUT
              message: The query took too long. Narrow the date range or use exports.
            request_id: req_01j9x4r2s3t4u5v6w7x8y9z0a2
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Your API key. Create one in Settings, API keys. Send it as
        `Authorization: Bearer rk_live_YOUR_KEY`.

````