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

# List content

> Lists content documents for the project with pagination. Response rows are summary fields only; use GET /content/:id for the full document.



## OpenAPI

````yaml /v2/openapi.json get /content
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:
  /content:
    get:
      tags:
        - Content
      summary: List content
      description: >-
        Lists content documents for the project with pagination. Response rows
        are summary fields only; use GET /content/:id for the full document.
      operationId: listContent
      parameters:
        - schema:
            type: integer
            default: 1
            minimum: 1
          in: query
          name: page
          required: false
          description: Page number (1-based).
        - schema:
            type: integer
            default: 25
            minimum: 1
            maximum: 100
          in: query
          name: size
          required: false
          description: Page size (max 100); matches other v2 list endpoints.
        - schema:
            type: string
            enum:
              - createdAt
              - updatedAt
            default: createdAt
          in: query
          name: orderBy
          required: false
          description: Sort field.
        - schema:
            type: string
            enum:
              - asc
              - desc
            default: desc
          in: query
          name: sortOrder
          required: false
          description: Sort direction.
        - schema:
            type: string
            enum:
              - CREATE
              - OPTIMIZE
          in: query
          name: mode
          required: false
          description: Filter by CREATE vs OPTIMIZE.
        - schema:
            type: string
            enum:
              - DRAFT
              - PENDING
              - IN_PROGRESS
              - COMPLETED
              - FAILED
              - STOPPED
          in: query
          name: status
          required: false
          description: Filter by generation status.
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  documents:
                    - id: 6ba7b82c-9dad-11d1-80b4-00c04fd430c8
                      status: COMPLETED
                      mode: CREATE
                      type: ARTICLE
                      title: Illustrative GEO checklist article
                      promptId: 6ba7b823-9dad-11d1-80b4-00c04fd430c8
                      prompt: How do I track AI search visibility?
                      createdAt: '2026-03-20T10:00:00.000Z'
                      updatedAt: '2026-03-20T10:08:00.000Z'
                      completedAt: '2026-03-20T10:08:00.000Z'
                    - id: 6ba7b82d-9dad-11d1-80b4-00c04fd430c8
                      status: FAILED
                      mode: OPTIMIZE
                      type: null
                      title: null
                      promptId: 6ba7b825-9dad-11d1-80b4-00c04fd430c8
                      prompt: How does Example Brand compare on integrations?
                      createdAt: '2026-03-21T09:00:00.000Z'
                      updatedAt: '2026-03-21T09:02:00.000Z'
                      completedAt: null
                  total: 2
                  page: 1
                  size: 25
                  totalPages: 1
                properties:
                  documents:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                        status:
                          type: string
                          enum:
                            - DRAFT
                            - PENDING
                            - IN_PROGRESS
                            - COMPLETED
                            - FAILED
                            - STOPPED
                          description: >-
                            PENDING: queued for generation; IN_PROGRESS: AI is
                            actively generating content; COMPLETED: generation
                            finished successfully; FAILED: generation
                            encountered an error; STOPPED: generation was
                            manually stopped by the user (may contain partial
                            content).
                        mode:
                          type: string
                          enum:
                            - CREATE
                            - OPTIMIZE
                          description: >-
                            CREATE: new content from a prompt; OPTIMIZE: rewrite
                            of an existing page.
                        type:
                          type: string
                          enum:
                            - ARTICLE
                            - BLOG_POST
                            - OPINION
                            - LISTICLE
                            - HOW_TO
                            - REVIEW
                            - COMPARISON
                            - CASE_STUDY
                            - INTERVIEW
                            - DOCUMENTATION
                            - WIKI
                            - PRODUCT_PAGE
                            - LANDING_PAGE
                            - PRESS_RELEASE
                            - GENERIC_CONTENT
                            - PRODUCT_COMPARISON
                          nullable: true
                          description: Content format (CREATE mode only).
                        title:
                          type: string
                          nullable: true
                          description: Document title; null until generation completes.
                        promptId:
                          type: string
                          format: uuid
                          nullable: true
                          description: Linked monitor prompt id.
                        prompt:
                          type: string
                          nullable: true
                          description: >-
                            Linked LLM prompt text; null if the prompt was
                            removed.
                        createdAt:
                          type: string
                          format: date-time
                        updatedAt:
                          type: string
                          format: date-time
                        completedAt:
                          type: string
                          format: date-time
                          nullable: true
                      required:
                        - id
                        - status
                        - mode
                        - type
                        - title
                        - promptId
                        - prompt
                        - createdAt
                        - updatedAt
                        - completedAt
                      additionalProperties: false
                    description: Documents for the current page (no full markdown body).
                  total:
                    type: integer
                    minimum: 0
                    description: Total documents matching filters (all pages).
                  page:
                    type: integer
                    minimum: 1
                  size:
                    type: integer
                    minimum: 1
                    description: Page length (same as request `size`).
                  totalPages:
                    type: integer
                    minimum: 0
                    description: Ceil(total / size).
                required:
                  - documents
                  - total
                  - page
                  - size
                  - totalPages
                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
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  code: CONTENT_NOT_FOUND
                  message: Content document not found
                properties:
                  code:
                    type: string
                    description: Machine-readable error code
                    enum:
                      - CONTENT_NOT_FOUND
                      - CONTENT_DRAFT_NOT_FOUND
                      - CONTENT_INVALID_PROMPT
                      - CONTENT_INVALID_PERSONA
                      - CONTENT_PAGE_FETCH_FAILED
                      - CONTENT_PAGE_NOT_FOUND
                      - CONTENT_PAGE_NO_CONTENT
                      - CONTENT_INVALID_TONE
                      - CONTENT_RECOMMENDATION_NOT_FOUND
                      - CONTENT_GENERATION_FAILED
                      - INTERNAL_ERROR
                    example: CONTENT_NOT_FOUND
                  message:
                    type: string
                    description: Human-readable error message
                    example: Content document not found
                required:
                  - code
                  - message
                additionalProperties: false
              examples:
                example1:
                  value:
                    code: CONTENT_NOT_FOUND
                    message: Content document not found
                example2:
                  value:
                    code: CONTENT_INVALID_PROMPT
                    message: Prompt not found or does not belong to this project
                example3:
                  value:
                    code: CONTENT_GENERATION_FAILED
                    message: Failed to start content generation
      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.

````