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

# List prompts



## OpenAPI

````yaml /api/openapi.yaml get /ai-search/prompts
openapi: 3.1.0
info:
  title: Beeze API
  version: v1
  description: >
    External Beeze API for pricing intelligence, domain research, AI Search, and
    integrations.
servers:
  - url: https://api.beeze.io/v1
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: AI Search
    description: Results, visibility, sources, competitors, prompts, and tags
  - name: Domain research
    description: Pricing intelligence, backlinks, prospects, overview stats, and trends
  - name: Integrations
    description: Usage for connected third-party integrations
paths:
  /ai-search/prompts:
    get:
      tags:
        - AI Search
      summary: List prompts
      operationId: listAiSearchPrompts
      parameters:
        - name: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - active
              - inactive
              - suggested
        - name: project
          in: query
          required: false
          schema:
            type: string
        - $ref: '#/components/parameters/Search'
        - $ref: '#/components/parameters/Limit50'
        - $ref: '#/components/parameters/FromDate'
        - $ref: '#/components/parameters/ToDate'
      responses:
        '200':
          description: Prompt list
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Prompt'
                  pagination:
                    $ref: '#/components/schemas/CursorPagination'
                  meta:
                    $ref: '#/components/schemas/PromptMeta'
                required:
                  - data
                  - pagination
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  parameters:
    Search:
      name: search
      in: query
      required: false
      schema:
        type: string
    Limit50:
      name: limit
      in: query
      required: false
      schema:
        type: integer
        minimum: 1
        maximum: 50
    FromDate:
      name: from
      in: query
      required: false
      schema:
        type: string
        format: date
      description: Start date in YYYY-MM-DD format
    ToDate:
      name: to
      in: query
      required: false
      schema:
        type: string
        format: date
      description: End date in YYYY-MM-DD format
  schemas:
    Prompt:
      type: object
      properties:
        id:
          type: string
          format: uuid
        promptText:
          type: string
        project:
          type: string
        location:
          type:
            - string
            - 'null'
        status:
          type: string
          enum:
            - active
            - inactive
            - suggested
        tags:
          type: array
          items:
            type: string
        createdAt:
          type: string
        updatedAt:
          type: string
        metrics:
          $ref: '#/components/schemas/PromptMetrics'
      required:
        - id
        - promptText
        - project
        - status
        - tags
        - createdAt
        - updatedAt
    CursorPagination:
      type: object
      properties:
        count:
          type: integer
        limit:
          type: integer
        hasMore:
          type: boolean
      required:
        - count
        - limit
        - hasMore
    PromptMeta:
      type: object
      properties:
        promptCount:
          type: integer
        promptLimit:
          type: integer
      required:
        - promptCount
        - promptLimit
    PromptMetrics:
      type: object
      properties:
        visibility:
          type: number
        position:
          type: number
        volume:
          type: number
        sentiment:
          type: number
        sentimentLabel:
          type: string
          enum:
            - positive
            - negative
            - neutral
    Problem:
      type: object
      properties:
        type:
          type: string
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
        code:
          type: string
        requestId:
          type: string
        instance:
          type: string
      required:
        - status
        - detail
        - code
  responses:
    BadRequest:
      description: Invalid request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Problem'
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Problem'
    Forbidden:
      description: Missing plan access, feature access, or workspace access
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Problem'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key for external Beeze API access

````