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

# List prompts

> Retrieve prompts in a category with optional filtering by type, topic, tag, region, platform, or persona. Supports cursor-based pagination.



## OpenAPI

````yaml https://app.stainless.com/api/spec/documented/profound/openapi.documented.yml get /v1/org/categories/{category_id}/prompts
openapi: 3.1.0
info:
  title: External API
  version: 6c43b49565a0c4e7cb023e22242cc3df28ee7153
servers:
  - url: https://api.tryprofound.com
    description: Production Server
security: []
paths:
  /v1/org/categories/{category_id}/prompts:
    get:
      tags:
        - Organization
        - Categories
      summary: List prompts
      description: >-
        Retrieve prompts in a category with optional filtering by type, topic,
        tag, region, platform, or persona. Supports cursor-based pagination.
      operationId: get_category_prompts_v1_org_categories__category_id__prompts_get
      parameters:
        - name: category_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Category Id
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 10000
            exclusiveMinimum: 0
            description: Maximum number of prompts to return.
            default: 10000
            title: Limit
          description: Maximum number of prompts to return.
        - name: cursor
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Pagination cursor from a previous response.
            title: Cursor
          description: Pagination cursor from a previous response.
        - name: order_dir
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/OrderByDirection'
            description: Sort direction by creation date.
            default: desc
          description: Sort direction by creation date.
        - name: analysis_type
          in: query
          required: false
          schema:
            type: array
            items:
              $ref: '#/components/schemas/AnalysisType'
            description: Filter by analysis type (visibility, sentiment, accuracy).
            default: []
            title: Analysis Type
          description: Filter by analysis type (visibility, sentiment, accuracy).
        - name: prompt_type
          in: query
          required: false
          schema:
            type: array
            items:
              $ref: '#/components/schemas/PromptType'
            description: Deprecated. Use analysis_type instead.
            deprecated: true
            default: []
            title: Prompt Type
          description: Deprecated. Use analysis_type instead.
          deprecated: true
        - name: status
          in: query
          required: false
          schema:
            type: array
            items:
              enum:
                - active
                - disabled
              type: string
            description: Filter by prompt status. Defaults to `active` only.
            default:
              - active
            title: Status
          description: Filter by prompt status. Defaults to `active` only.
        - name: topic_id
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              format: uuid
            description: Filter by topic IDs.
            default: []
            title: Topic Id
          description: Filter by topic IDs.
        - name: tag_id
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              format: uuid
            description: Filter by tag IDs.
            default: []
            title: Tag Id
          description: Filter by tag IDs.
        - name: region_id
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              format: uuid
            description: Filter by region IDs.
            default: []
            title: Region Id
          description: Filter by region IDs.
        - name: platform_id
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              format: uuid
            description: Filter by platform IDs.
            default: []
            title: Platform Id
          description: Filter by platform IDs.
        - name: persona_id
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              format: uuid
            description: Filter by persona IDs.
            default: []
            title: Persona Id
          description: Filter by persona IDs.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CategoryPromptsResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyHeader: []
        - BearerAuth: []
      x-codeSamples:
        - lang: JavaScript
          source: |-
            import Profound from '@profoundai/client';

            const client = new Profound({
              apiKey: process.env['PROFOUND_API_KEY'], // This is the default and can be omitted
            });

            const response = await client.organizations.categories.prompts(
              '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
            );

            console.log(response.data);
        - lang: Python
          source: |-
            import os
            from profound import Profound

            client = Profound(
                api_key=os.environ.get("PROFOUND_API_KEY"),  # This is the default and can be omitted
            )
            response = client.organizations.categories.prompts(
                category_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            )
            print(response.data)
components:
  schemas:
    OrderByDirection:
      type: string
      enum:
        - asc
        - desc
      title: OrderByDirection
    AnalysisType:
      type: string
      enum:
        - visibility
        - sentiment
        - sentiment_v2
        - accuracy
      title: AnalysisType
    PromptType:
      type: string
      enum:
        - visibility
        - sentiment
      title: PromptType
    CategoryPromptsResponse:
      properties:
        info:
          $ref: '#/components/schemas/PaginationInfo'
        data:
          items:
            $ref: '#/components/schemas/Prompt'
          type: array
          title: Data
      type: object
      required:
        - info
        - data
      title: CategoryPromptsResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PaginationInfo:
      properties:
        total_rows:
          type: integer
          title: Total Rows
        limit:
          type: integer
          title: Limit
        next_cursor:
          anyOf:
            - type: string
            - type: 'null'
          title: Next Cursor
      type: object
      required:
        - total_rows
        - limit
        - next_cursor
      title: PaginationInfo
    Prompt:
      properties:
        id:
          type: string
          title: Id
        analysis_types:
          items:
            type: string
            enum:
              - visibility
              - sentiment
              - sentiment_v2
              - accuracy
          type: array
          title: Analysis Types
          default: []
        prompt_type:
          type: string
          title: Prompt Type
          default: ''
          deprecated: true
        prompt:
          type: string
          title: Prompt
        language:
          type: string
          title: Language
        status:
          type: string
          enum:
            - active
            - disabled
          title: Status
        topic:
          $ref: '#/components/schemas/NamedResource'
        tags:
          items:
            $ref: '#/components/schemas/NamedResource'
          type: array
          title: Tags
          default: []
        regions:
          items:
            $ref: '#/components/schemas/NamedResource'
          type: array
          title: Regions
        platforms:
          items:
            $ref: '#/components/schemas/NamedResource'
          type: array
          title: Platforms
        personas:
          items:
            $ref: '#/components/schemas/NamedResource'
          type: array
          title: Personas
          default: []
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
      type: object
      required:
        - id
        - prompt
        - language
        - status
        - topic
        - regions
        - platforms
        - created_at
        - updated_at
      title: Prompt
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    NamedResource:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
      type: object
      required:
        - id
        - name
      title: NamedResource
      description: Generic id+name reference used across domain boundaries.
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key
    BearerAuth:
      type: http
      scheme: bearer

````