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

# Get Prompt

> Get a single prompt by ID



## OpenAPI

````yaml /v2/openapi.json get /prompts/{id}
openapi: 3.0.0
info:
  title: Promptwatch API v2
  description: >-
    API v2 for customer integrations with Promptwatch monitoring platform. This
    version provides improved structure, additional endpoints, and enhanced
    functionality.
  version: 2.0.0
  contact:
    name: Promptwatch Support
    email: team@promptwatch.com
    url: https://promptwatch.com
  license:
    name: Commercial
    url: https://promptwatch.com/terms-and-conditions
servers:
  - url: https://server.promptwatch.com/api/v2
    description: Promptwatch API v2
security: []
tags:
  - name: Authentication
    description: API key validation and authentication
  - name: Content
    description: >-
      AI content generation and optimization. Create content asynchronously and
      poll for results.
  - name: Content Gap
    description: Content gap analysis and recommendations
  - name: Models
    description: Available LLM models
  - name: Monitors
    description: Monitor management and CRUD operations
  - name: Page Tracker
    description: Track URLs and inspect citation stats, responses, and prompts
  - name: Prompts
    description: Prompt management and operations
  - name: Query Fanouts
    description: ChatGPT query fanout keywords
  - name: Responses
    description: LLM response data and analytics
  - name: Tags
    description: Tag management for prompts
  - name: Topics
    description: Topic management for prompts
  - name: Actions
    description: Action items (GEO suggestions and tasks)
  - name: Personas
    description: Persona configuration for monitors
  - name: Brands
    description: Brand management for competitive analysis
  - name: Visibility
    description: Brand visibility time series and competitor heatmaps
  - name: Citations
    description: Citation analytics from AI responses
  - name: Analytics
    description: Visitor analytics, AI crawler logs, sentiment, and brand visibility trends
  - name: Projects
    description: Project management (organization-level keys only)
  - name: Sitemap
    description: Sitemap crawl progress and discovered URLs
  - name: Site Health
    description: >-
      Crawled pages with SEO issues (titles, meta descriptions, H1, thin
      content)
  - name: Socials
    description: >-
      Social media citations (Reddit posts and YouTube videos) found in LLM
      responses
paths:
  /prompts/{id}:
    get:
      tags:
        - Prompts
      summary: Get Prompt
      description: Get a single prompt by ID
      operationId: getPrompt
      parameters:
        - schema:
            type: string
            format: uuid
          in: path
          name: id
          required: true
          description: Prompt ID
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  id: 6ba7b82e-9dad-11d1-80b4-00c04fd430c8
                  prompt: What is the best workflow automation tool for finance teams?
                  type: ORGANIC
                  intent: INFORMATIONAL
                  isActive: true
                  languageCode: en-US
                  llmMonitorId: 6ba7b815-9dad-11d1-80b4-00c04fd430c8
                  llmMonitor:
                    id: 6ba7b815-9dad-11d1-80b4-00c04fd430c8
                    name: US English monitor
                  amountOfResponses: 36
                  averageVisibility: 49.5
                  volume: 8800
                  difficulty: 37
                  createdAt: '2026-02-05T11:00:00.000Z'
                  updatedAt: '2026-03-29T18:20:00.000Z'
                properties:
                  id:
                    type: string
                    format: uuid
                    description: Prompt identifier
                  prompt:
                    type: string
                    description: The prompt text
                  type:
                    type: string
                    enum:
                      - ORGANIC
                      - BRAND_SPECIFIC
                      - COMPETITOR_COMPARISON
                    description: Type of prompt
                  intent:
                    type: string
                    enum:
                      - BRANDED
                      - INFORMATIONAL
                      - NAVIGATIONAL
                      - COMMERCIAL
                      - TRANSACTIONAL
                    nullable: true
                    description: Intent of the prompt
                  isActive:
                    type: boolean
                    description: Whether the prompt is active
                  languageCode:
                    type: string
                    description: Language code for the prompt
                  llmMonitorId:
                    type: string
                    format: uuid
                    description: Monitor that owns this prompt
                  llmMonitor:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                        description: Monitor identifier
                      name:
                        type: string
                        description: Monitor name
                    required:
                      - id
                      - name
                    additionalProperties: false
                  amountOfResponses:
                    type: number
                    description: Total number of responses for this prompt
                  averageVisibility:
                    type: number
                    nullable: true
                    description: Average visibility score across all responses
                  volume:
                    type: number
                    nullable: true
                    description: >-
                      Weighted search volume across all keywords (Google + Bing
                      + AI). Null if no keyword data available.
                  difficulty:
                    type: number
                    nullable: true
                    description: Weighted average keyword difficulty across all keywords
                  createdAt:
                    type: string
                    format: date-time
                    description: Prompt creation timestamp
                  updatedAt:
                    type: string
                    format: date-time
                    description: Prompt last update timestamp
                required:
                  - id
                  - prompt
                  - type
                  - isActive
                  - languageCode
                  - llmMonitorId
                  - llmMonitor
                  - amountOfResponses
                  - volume
                  - createdAt
                  - updatedAt
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  error: Unauthorized
                  message: Missing or invalid X-API-Key header.
                properties:
                  error:
                    type: string
                    description: Error category (often aligned with HTTP semantics)
                  code:
                    type: string
                    description: Optional machine-readable code
                  message:
                    type: string
                    description: Human-readable explanation
                  details:
                    type: object
                    description: Optional structured detail (e.g. validation)
                    additionalProperties: true
                required:
                  - error
                  - message
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  code: PROMPT_NOT_FOUND
                  message: Prompt not found or access denied
                properties:
                  code:
                    type: string
                    description: Error code indicating the type of error
                    enum:
                      - PROMPT_NOT_FOUND
                      - PROMPT_KEYWORDS_REQUIRED
                      - PROMPT_CLASSIFICATION_FAILED
                      - PROMPT_INVALID_MOVE_LANGUAGE
                      - MONITOR_NOT_FOUND
                      - PROJECT_NOT_FOUND
                      - PERSONA_NOT_FOUND
                      - INTERNAL_ERROR
                    example: PROMPT_NOT_FOUND
                  message:
                    type: string
                    description: Human-readable error message
                    example: Prompt not found or access denied
                required:
                  - code
                  - message
                additionalProperties: false
              examples:
                example1:
                  value:
                    code: PROMPT_NOT_FOUND
                    message: Prompt not found or access denied
                example2:
                  value:
                    code: PROMPT_KEYWORDS_REQUIRED
                    message: Keywords are required for keywords generation type
                example3:
                  value:
                    code: PROMPT_CLASSIFICATION_FAILED
                    message: All prompt classifications failed
                example4:
                  value:
                    code: INTERNAL_ERROR
                    message: An unexpected error occurred
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  code: PROMPT_NOT_FOUND
                  message: Prompt not found or access denied
                properties:
                  code:
                    type: string
                    description: Error code indicating the type of error
                    enum:
                      - PROMPT_NOT_FOUND
                      - PROMPT_KEYWORDS_REQUIRED
                      - PROMPT_CLASSIFICATION_FAILED
                      - PROMPT_INVALID_MOVE_LANGUAGE
                      - MONITOR_NOT_FOUND
                      - PROJECT_NOT_FOUND
                      - PERSONA_NOT_FOUND
                      - INTERNAL_ERROR
                    example: PROMPT_NOT_FOUND
                  message:
                    type: string
                    description: Human-readable error message
                    example: Prompt not found or access denied
                required:
                  - code
                  - message
                additionalProperties: false
              examples:
                example1:
                  value:
                    code: PROMPT_NOT_FOUND
                    message: Prompt not found or access denied
                example2:
                  value:
                    code: PROMPT_KEYWORDS_REQUIRED
                    message: Keywords are required for keywords generation type
                example3:
                  value:
                    code: PROMPT_CLASSIFICATION_FAILED
                    message: All prompt classifications failed
                example4:
                  value:
                    code: INTERNAL_ERROR
                    message: An unexpected error occurred
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        API key for authentication. Get yours from the Promptwatch dashboard
        under Settings > API Keys.

````