> ## 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.

# Get a prompt



## OpenAPI

````yaml /api/openapi.yaml get /ai-search/prompts/{id}
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/{id}:
    get:
      tags:
        - AI Search
      summary: Get a prompt
      operationId: getAiSearchPrompt
      parameters:
        - $ref: '#/components/parameters/PromptPathId'
      responses:
        '200':
          description: Prompt detail
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Prompt'
                required:
                  - data
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    PromptPathId:
      name: id
      in: path
      required: true
      schema:
        type: string
        format: uuid
  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
    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:
    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'
    NotFound:
      description: Resource not found
      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

````