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

# Read the filtered prompt inventory

> Same workspace feature and role permissions as the app. Writes commit their successful retry receipt atomically. List filters use comma-separated values. Follow nextCursor or previousCursor with navigationDirection to paginate. Rows contain numeric prompt, group and persona IDs. Applied state reports the normalized filters.



## OpenAPI

````yaml GET /api/v2/prompts/inventory
openapi: 3.1.1
info:
  title: chatobserver public API
  version: '2026-09-09'
  description: >-
    Track AI visibility, manage prompts, inspect collected answers and
    citations, and integrate workspace data with your own tools. Visibility
    endpoints use workspace API keys. Data endpoints use scoped service-account
    keys; spreadsheet client endpoints use authorised client sessions. See the
    authentication guide for each credential type.
  contact:
    name: chatobserver support
    url: https://chatobserver.com/contact
    email: support@chatobserver.com
servers:
  - url: https://app.chatobserver.com
    description: Production API
security:
  - WorkspaceKey: []
  - BearerKey: []
tags:
  - name: Workspace
    description: Validate access and list the workspace project and available platforms.
  - name: Prompts
    description: Create, schedule, organise, activate and retrieve tracked prompts.
  - name: Answers
    description: Retrieve collected AI answers, their analysis and visibility trends.
  - name: Brands
    description: Manage brands and compare their visibility in AI answers.
  - name: Sources and citations
    description: Analyse cited domains, pages and ownership across answers.
  - name: Visitor analytics
    description: Read website visitor and crawler analytics for the workspace.
  - name: Content opportunities
    description: Retrieve content-gap findings and recommendations for tracked prompts.
  - name: Usage
    description: Read workspace consumption and allowance summaries.
  - name: Data connections
    description: Discover authorised connections, source accounts and connector catalogues.
  - name: Data queries
    description: >-
      Create versioned queries, publish definitions and inspect integration
      contracts.
  - name: Data operations
    description: >-
      Execute, validate, cancel and inspect operations and page through result
      rows.
  - name: Data delivery
    description: Manage schedules, transfers, destinations and import workflows.
  - name: Data definitions
    description: Manage reusable definitions and their immutable versions.
  - name: Data webhooks
    description: >-
      Configure event delivery, inspect deliveries, replay events and rotate
      secrets.
  - name: Client authorisation
    description: Authorise spreadsheet clients using a user-approved challenge exchange.
  - name: Spreadsheet clients
    description: >-
      Access document-bound client sessions, queries, schedules, bindings and
      write claims.
  - name: AI visibility audits
    description: Create website visibility audits and retrieve their report links.
  - name: Version 1
    description: Integrate with the version 1 visibility and analytics endpoints.
paths:
  /api/v2/prompts/inventory:
    get:
      tags:
        - Prompts
      summary: Read the filtered prompt inventory
      description: >-
        Same workspace feature and role permissions as the app. Writes commit
        their successful retry receipt atomically. List filters use
        comma-separated values. Follow nextCursor or previousCursor with
        navigationDirection to paginate. Rows contain numeric prompt, group and
        persona IDs. Applied state reports the normalized filters.
      operationId: getV2PromptsInventory
      parameters:
        - name: search
          in: query
          required: false
          schema:
            type: string
            maxLength: 500
        - name: statusTab
          in: query
          required: false
          schema:
            type: string
            enum:
              - all
              - needs_attention
              - scheduled
              - paused
              - completed
        - name: status
          in: query
          required: false
          schema:
            type: string
            maxLength: 100
        - name: runState
          in: query
          required: false
          schema:
            type: string
            maxLength: 150
        - name: platforms
          in: query
          required: false
          schema:
            type: string
            maxLength: 500
        - name: regions
          in: query
          required: false
          schema:
            type: string
            maxLength: 2000
        - name: groups
          in: query
          required: false
          schema:
            type: string
            maxLength: 500
        - name: personas
          in: query
          required: false
          schema:
            type: string
            maxLength: 500
        - name: sort
          in: query
          required: false
          schema:
            type: string
            enum:
              - default
              - prompt
              - visibility
              - groups
              - models
              - regions
              - lastRunAt
              - updatedAt
              - status
              - operationalStatus
              - resultSyncStatus
        - name: direction
          in: query
          required: false
          schema:
            type: string
            enum:
              - asc
              - desc
        - name: pageSize
          in: query
          required: false
          schema:
            type: number
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100000
        - name: cursor
          in: query
          required: false
          schema:
            type: string
            maxLength: 8192
        - name: navigationDirection
          in: query
          required: false
          schema:
            type: string
            enum:
              - next
              - prev
      responses:
        '200':
          description: Successful operation.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      rows:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: number
                            label:
                              type: string
                            excerpt:
                              type: string
                            promptText:
                              type: string
                            status:
                              enum:
                                - active
                                - inactive
                                - archived
                              type: string
                            lastRunAt:
                              type:
                                - string
                                - 'null'
                            nextRunAt:
                              type:
                                - string
                                - 'null'
                            resultSyncStatus:
                              type: string
                              enum:
                                - pending
                                - queued
                                - running
                                - complete
                                - failed
                                - credit_hold
                            isRunning:
                              type: boolean
                            targetPlatforms:
                              type: array
                              items:
                                enum:
                                  - chatgpt
                                  - ai_overview
                                  - ai_mode
                                  - gemini
                                  - perplexity
                                  - claude
                                type: string
                            targetRegions:
                              type: array
                              items:
                                type: string
                            analysisPolicy:
                              anyOf:
                                - type: object
                                  properties:
                                    ranking:
                                      type: string
                                      enum:
                                        - auto
                                        - always
                                        - never
                                    sentiment:
                                      type: string
                                      enum:
                                        - auto
                                        - always
                                        - never
                                  additionalProperties: false
                                - type: 'null'
                            personaIds:
                              type: array
                              items:
                                type: number
                            groupIds:
                              type: array
                              items:
                                type: number
                            scheduleFrequency:
                              type: string
                            scheduleHour:
                              type: number
                            scheduleMinute:
                              type: number
                            scheduleTimezone:
                              type: string
                            scheduleIntervalMinutes:
                              type:
                                - number
                                - 'null'
                            scheduleDaysOfWeek:
                              anyOf:
                                - type: array
                                  items:
                                    type: number
                                - type: 'null'
                            createdAt:
                              type: string
                            updatedAt:
                              type: string
                            archivedAt:
                              type:
                                - string
                                - 'null'
                            visibility:
                              anyOf:
                                - type: object
                                  properties:
                                    windowDays:
                                      type: number
                                    answerCount:
                                      type: number
                                    rankingEligibleAnswerCount:
                                      type: number
                                    presenceCount:
                                      type: number
                                    firstPlaceCount:
                                      type: number
                                    presenceRate:
                                      type:
                                        - number
                                        - 'null'
                                    firstPlaceRate:
                                      type:
                                        - number
                                        - 'null'
                                    ownAverageBestRank:
                                      type:
                                        - number
                                        - 'null'
                                    bestCompetitorAverageRank:
                                      type:
                                        - number
                                        - 'null'
                                  required:
                                    - windowDays
                                    - answerCount
                                    - presenceCount
                                    - firstPlaceCount
                                    - presenceRate
                                    - firstPlaceRate
                                    - ownAverageBestRank
                                    - bestCompetitorAverageRank
                                  additionalProperties: false
                                - type: 'null'
                          required:
                            - id
                            - label
                            - excerpt
                            - status
                            - lastRunAt
                            - nextRunAt
                            - resultSyncStatus
                            - targetPlatforms
                            - targetRegions
                            - analysisPolicy
                            - personaIds
                            - groupIds
                            - scheduleFrequency
                            - scheduleHour
                            - scheduleMinute
                            - scheduleTimezone
                            - scheduleIntervalMinutes
                            - scheduleDaysOfWeek
                            - createdAt
                            - updatedAt
                            - archivedAt
                            - visibility
                          additionalProperties: false
                      totalCount:
                        type:
                          - number
                          - 'null'
                      summary:
                        anyOf:
                          - type: object
                            properties:
                              totalCount:
                                type: number
                              hasCompletedAnswer:
                                type: boolean
                              scheduledToday:
                                type: number
                              needsAttention:
                                type: number
                              averageVisibility:
                                type:
                                  - number
                                  - 'null'
                              paused:
                                type: number
                              completed:
                                type: number
                            required:
                              - totalCount
                              - hasCompletedAnswer
                              - scheduledToday
                              - needsAttention
                              - averageVisibility
                              - paused
                              - completed
                            additionalProperties: false
                          - type: 'null'
                      pageSize:
                        type: number
                      nextCursor:
                        type:
                          - string
                          - 'null'
                      previousCursor:
                        type:
                          - string
                          - 'null'
                      appliedState:
                        type: object
                        properties:
                          searchTerm:
                            type: string
                          statusTab:
                            type: string
                            enum:
                              - all
                              - needs_attention
                              - scheduled
                              - paused
                              - completed
                          statusFilters:
                            type: array
                            items:
                              enum:
                                - active
                                - inactive
                                - archived
                              type: string
                          runStateFilters:
                            type: array
                            items:
                              type: string
                              enum:
                                - pending
                                - queued
                                - running
                                - complete
                                - failed
                                - credit_hold
                          platformFilters:
                            type: array
                            items:
                              enum:
                                - chatgpt
                                - ai_overview
                                - ai_mode
                                - gemini
                                - perplexity
                                - claude
                              type: string
                          regionFilters:
                            type: array
                            items:
                              type: string
                          groupFilters:
                            type: array
                            items:
                              type: number
                          personaFilters:
                            type: array
                            items:
                              type: number
                          sortKey:
                            type: string
                            enum:
                              - default
                              - prompt
                              - visibility
                              - groups
                              - models
                              - regions
                              - lastRunAt
                              - updatedAt
                              - status
                              - operationalStatus
                              - resultSyncStatus
                          sortDirection:
                            type: string
                            enum:
                              - asc
                              - desc
                          pageSize:
                            type: number
                          page:
                            type: number
                          paginationDirection:
                            type: string
                            enum:
                              - next
                              - prev
                          cursor:
                            type:
                              - string
                              - 'null'
                        required:
                          - searchTerm
                          - statusTab
                          - statusFilters
                          - runStateFilters
                          - platformFilters
                          - regionFilters
                          - groupFilters
                          - personaFilters
                          - sortKey
                          - sortDirection
                          - pageSize
                          - page
                          - paginationDirection
                          - cursor
                        additionalProperties: false
                    required:
                      - rows
                      - totalCount
                      - summary
                      - pageSize
                      - nextCursor
                      - previousCursor
                      - appliedState
                    additionalProperties: false
                required:
                  - data
                additionalProperties: false
        '400':
          description: Invalid input.
        '403':
          description: Scope, role, personal ownership or feature access denied.
        '404':
          description: Record not found.
        '409':
          description: Revision, opportunity or retry conflict.
components:
  securitySchemes:
    WorkspaceKey:
      type: apiKey
      in: header
      name: x-chatobserver-key
      description: >-
        A workspace API key. Data endpoints require a service-account key with
        the specified scopes.
    BearerKey:
      type: http
      scheme: bearer
      description: The workspace or service-account API key as a bearer token.

````