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

# List prompts

> Tracked prompts with their mention and citation rates for the period. Requires `visibility:read`.



## OpenAPI

````yaml /openapi.yaml get /visibility/prompts
openapi: 3.1.0
info:
  title: AeoNut API
  version: '1.0'
  description: >
    Read your workspace's AI visibility, content map and content data. Every
    response is wrapped in

    `{code, messages, data}`. Rates are fractions between 0 and 1 unless a field
    says otherwise.
servers:
  - url: https://services.deepsmith.ai/core/api/external/v1
security:
  - bearerAuth: []
  - apiKeyHeader: []
tags:
  - name: Me
  - name: Workspace
  - name: AI visibility
  - name: Content map
  - name: Content
  - name: IQ
paths:
  /visibility/prompts:
    get:
      tags:
        - AI visibility
      summary: List prompts
      description: >-
        Tracked prompts with their mention and citation rates for the period.
        Requires `visibility:read`.
      parameters:
        - $ref: '#/components/parameters/Range'
        - name: search
          in: query
          description: Case-insensitive match on prompt text.
          schema:
            type: string
            maxLength: 255
        - name: category_id
          in: query
          description: >-
            A category ID, or `__uncategorized__` for prompts without a
            category.
          schema:
            type: string
        - name: sort
          in: query
          schema:
            type: string
            enum:
              - created_at
              - category
              - mention_rate
              - citation_rate
            default: created_at
        - $ref: '#/components/parameters/Order'
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/PerPage'
      responses:
        '200':
          description: Prompts
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Envelope'
                  - properties:
                      data:
                        type: object
                        properties:
                          prompts:
                            type: array
                            items:
                              $ref: '#/components/schemas/Prompt'
                          pagination:
                            $ref: '#/components/schemas/Pagination'
                            description: >-
                              Missing when AI visibility tracking isn't set up
                              yet.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  parameters:
    Range:
      name: range
      in: query
      description: >-
        The period to report on. The previous period of the same length is
        returned for comparison.
      schema:
        $ref: '#/components/schemas/RangeValue'
    Order:
      name: order
      in: query
      schema:
        type: string
        enum:
          - asc
          - desc
        default: desc
    Page:
      name: page
      in: query
      schema:
        type: integer
        minimum: 1
        default: 1
    PerPage:
      name: per_page
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 20
  schemas:
    Envelope:
      type: object
      properties:
        code:
          type: integer
          description: AeoNut status code
        messages:
          type: string
        data: {}
    Prompt:
      type: object
      properties:
        id:
          type: string
          format: uuid
        text:
          type: string
        category_id:
          type:
            - string
            - 'null'
          format: uuid
        category:
          type:
            - object
            - 'null'
          properties:
            id:
              type: string
              format: uuid
            name:
              type: string
            color:
              type: string
        mention_rate:
          type:
            - number
            - 'null'
        mention_rate_delta:
          type:
            - number
            - 'null'
        citation_rate:
          type:
            - number
            - 'null'
        citation_rate_delta:
          type:
            - number
            - 'null'
        last_collected_at:
          type:
            - string
            - 'null'
        status:
          type: string
          enum:
            - PENDING
            - GENERATING
            - ACTIVE
        created_at:
          type: string
          format: date-time
    Pagination:
      type: object
      properties:
        from:
          type:
            - integer
            - 'null'
        to:
          type:
            - integer
            - 'null'
        count:
          type: integer
        per_page:
          type: integer
        current_page:
          type: integer
        total:
          type: integer
        total_pages:
          type: integer
        next_url:
          type:
            - string
            - 'null'
        prev_url:
          type:
            - string
            - 'null'
    RangeValue:
      type: string
      enum:
        - 7d
        - 30d
        - 90d
      default: 30d
    Scope:
      type: string
      enum:
        - workspace:read
        - visibility:read
        - contentmap:read
        - content:read
        - iq:read
  responses:
    Unauthorized:
      description: Missing (`code` 4021), invalid, revoked or expired (`code` 4022) API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Envelope'
          example:
            code: 4022
            messages: Invalid, revoked or expired API key.
            data: null
    Forbidden:
      description: The key lacks a required scope
      content:
        application/json:
          schema:
            allOf:
              - $ref: '#/components/schemas/Envelope'
              - properties:
                  data:
                    type: object
                    properties:
                      required:
                        type: array
                        items:
                          $ref: '#/components/schemas/Scope'
                      missing:
                        type: array
                        items:
                          $ref: '#/components/schemas/Scope'
          example:
            code: 4023
            messages: This API key does not have the scope required for this request.
            data:
              required:
                - visibility:read
              missing:
                - visibility:read
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Your API key: `Authorization: Bearer API Key Value`'
    apiKeyHeader:
      type: apiKey
      in: header
      name: X-API-KEY

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.