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

# List prompts

> The Site's prompt catalogue — each question's text, category, tags, products, personas, and journey stages, with its stable promptId. Cursor-paginated.



## OpenAPI

````yaml /openapi/public-api-v1.json get /v1/sites/{siteId}/prompts
openapi: 3.0.0
info:
  title: Onsomble API
  description: >-
    Connect Onsomble to your reporting and operational workflows. Read
    discoverability results or start a Scan from another system.
  version: 1.0.0
  contact: {}
servers:
  - url: https://api.onsomble.ai
    description: Production
security:
  - apiKeyAuth: []
tags:
  - name: Sites
    description: Sites connected to your account.
  - name: Clients
    description: Clients managed by agency accounts.
  - name: Scans
    description: Scan history, status, and controls.
  - name: Reports
    description: AI discoverability results.
paths:
  /v1/sites/{siteId}/prompts:
    get:
      tags:
        - Sites
      summary: List prompts
      description: >-
        The Site's prompt catalogue — each question's text, category, tags,
        products, personas, and journey stages, with its stable promptId.
        Cursor-paginated.
      operationId: listPrompts
      parameters:
        - name: siteId
          required: true
          in: path
          schema:
            type: string
        - name: cursor
          required: false
          in: query
          description: >-
            Opaque cursor from the previous page (nextCursor). Omit for the
            first page.
          schema:
            type: string
        - name: limit
          required: false
          in: query
          schema:
            minimum: 1
            maximum: 100
            default: 25
            type: number
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicPromptsListResponseDto'
        '404':
          description: Site not found.
components:
  schemas:
    PublicPromptsListResponseDto:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PublicPromptDto'
        nextCursor:
          type: string
          nullable: true
          description: 'Opaque cursor: pass back as `cursor` for the next page.'
      required:
        - data
        - nextCursor
    PublicPromptDto:
      type: object
      properties:
        promptId:
          type: string
          format: uuid
          description: The prompt id carried by prompt-results, narratives, and claims.
        text:
          type: string
          example: What should I look for when choosing car insurance?
        category:
          type: string
          nullable: true
          example: general
        tags:
          example:
            - coverage options
            - excesses
          type: array
          items:
            type: string
        products:
          type: array
          items:
            $ref: '#/components/schemas/PublicPromptRefValueDto'
        personas:
          type: array
          items:
            $ref: '#/components/schemas/PublicPromptRefValueDto'
        journeyStages:
          type: array
          items:
            $ref: '#/components/schemas/PublicPromptRefValueDto'
      required:
        - promptId
        - text
        - category
        - tags
        - products
        - personas
        - journeyStages
    PublicPromptRefValueDto:
      type: object
      properties:
        value:
          type: string
          example: home-contents-insurance
          description: The token the matching filter param accepts.
        label:
          type: string
          example: Home & Contents Insurance
      required:
        - value
        - label
  securitySchemes:
    apiKeyAuth:
      scheme: bearer
      bearerFormat: ons_…
      type: http
      description: An API key created in Settings → Account → API Keys.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.