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

# List Public Retrievers

> List all public retrievers with pagination and search.

This endpoint allows browsing and discovering all published retrievers
across all organizations. No authentication required.

**Authentication:**
- NO authentication required - completely public endpoint
- Discover retrievers created by all Mixpeek users

**Pagination:**
- Default: page=1, page_size=20
- Maximum page_size: 100
- Returns total count and total pages

**Search:**
- Search across retriever titles and descriptions
- Case-insensitive regex matching
- Combine with pagination

**Filtering:**
- By default, only active retrievers are shown
- Set `include_inactive=true` to see all retrievers

**Response includes:**
- List of public retrievers with basic info
- Pagination details (page, page_size, total_count, total_pages)
- Aggregate statistics (total active, password protected, open)

**What's NOT exposed:**
- API keys (except in individual config endpoint)
- Internal IDs or organization details
- Full retriever configuration (use template endpoint for that)
- Password values (only password_protected: true/false)

**Example:**
```bash
# List all public retrievers (first page)
curl -X GET "https://api.mixpeek.com/v1/public/retrievers/"

# Search for video-related retrievers
curl -X GET "https://api.mixpeek.com/v1/public/retrievers/?search=video&page_size=50"

# Get page 2 with custom page size
curl -X GET "https://api.mixpeek.com/v1/public/retrievers/?page=2&page_size=50"
```

**Use Cases:**
- Browse available public retrievers
- Discover search patterns and implementations
- Find retrievers to use as templates
- Explore what others have built



## OpenAPI

````yaml get /v1/public/retrievers/
openapi: 3.1.0
info:
  title: Mixpeek API
  description: >-
    This is the Mixpeek API, providing access to various endpoints for data
    processing and retrieval.
  termsOfService: https://mixpeek.com/terms
  contact:
    name: Mixpeek Support
    url: https://mixpeek.com/contact
    email: info@mixpeek.com
  version: '0.82'
servers:
  - url: https://api.mixpeek.com
    description: Production
security: []
paths:
  /v1/public/retrievers/:
    get:
      tags:
        - Public Retriever API
      summary: List Public Retrievers
      description: >-
        List all public retrievers with pagination and search.


        This endpoint allows browsing and discovering all published retrievers

        across all organizations. No authentication required.


        **Authentication:**

        - NO authentication required - completely public endpoint

        - Discover retrievers created by all Mixpeek users


        **Pagination:**

        - Default: page=1, page_size=20

        - Maximum page_size: 100

        - Returns total count and total pages


        **Search:**

        - Search across retriever titles and descriptions

        - Case-insensitive regex matching

        - Combine with pagination


        **Filtering:**

        - By default, only active retrievers are shown

        - Set `include_inactive=true` to see all retrievers


        **Response includes:**

        - List of public retrievers with basic info

        - Pagination details (page, page_size, total_count, total_pages)

        - Aggregate statistics (total active, password protected, open)


        **What's NOT exposed:**

        - API keys (except in individual config endpoint)

        - Internal IDs or organization details

        - Full retriever configuration (use template endpoint for that)

        - Password values (only password_protected: true/false)


        **Example:**

        ```bash

        # List all public retrievers (first page)

        curl -X GET "https://api.mixpeek.com/v1/public/retrievers/"


        # Search for video-related retrievers

        curl -X GET
        "https://api.mixpeek.com/v1/public/retrievers/?search=video&page_size=50"


        # Get page 2 with custom page size

        curl -X GET
        "https://api.mixpeek.com/v1/public/retrievers/?page=2&page_size=50"

        ```


        **Use Cases:**

        - Browse available public retrievers

        - Discover search patterns and implementations

        - Find retrievers to use as templates

        - Explore what others have built
      operationId: list_public_retrievers_v1_public_retrievers__get
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: integer
            maximum: 500
            minimum: 1
            description: Page number (1-indexed)
            default: 1
            title: Page
          description: Page number (1-indexed)
        - name: page_size
          in: query
          required: false
          schema:
            type: integer
            maximum: 1000
            minimum: 1
            description: Results per page
            default: 20
            title: Page Size
          description: Results per page
        - name: include_inactive
          in: query
          required: false
          schema:
            type: boolean
            description: Include inactive retrievers in results
            default: false
            title: Include Inactive
          description: Include inactive retrievers in results
        - name: search
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                maxLength: 200
              - type: 'null'
            description: Search query for filtering by title or description
            title: Search
          description: Search query for filtering by title or description
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPublicRetrieversResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    ListPublicRetrieversResponse:
      properties:
        results:
          items:
            $ref: '#/components/schemas/PublicRetrieverListItem'
          type: array
          title: Results
          description: List of public retrievers
        total_count:
          type: integer
          title: Total Count
          description: Total number of public retrievers matching the query
        page:
          type: integer
          title: Page
          description: Current page number
        page_size:
          type: integer
          title: Page Size
          description: Results per page
        total_pages:
          type: integer
          title: Total Pages
          description: Total number of pages
        stats:
          anyOf:
            - $ref: '#/components/schemas/PublicRetrieverListStats'
            - type: 'null'
          description: Aggregate statistics across all public retrievers
      type: object
      required:
        - results
        - total_count
        - page
        - page_size
        - total_pages
      title: ListPublicRetrieversResponse
      description: >-
        Response for listing public retrievers.


        Follows the same pattern as ListCollectionsResponse for consistent
        developer experience.
    ErrorResponse:
      properties:
        success:
          type: boolean
          title: Success
          description: Always false for error responses
          default: false
        status:
          type: integer
          title: Status
          description: HTTP status code for this error
        error:
          $ref: '#/components/schemas/ErrorDetail'
          description: Error details payload
      type: object
      required:
        - status
        - error
      title: ErrorResponse
      description: Error response model.
      examples:
        - error:
            details:
              id: ns_123
              resource: namespace
            message: Namespace not found
            type: NotFoundError
          status: 404
          success: false
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PublicRetrieverListItem:
      properties:
        public_name:
          type: string
          title: Public Name
          description: Public URL-safe name used in the public URL
        public_url:
          type: string
          title: Public Url
          description: Full public URL to the retriever page
          examples:
            - https://mxp.co/r/video-search
        title:
          type: string
          title: Title
          description: Display title from display_config
          examples:
            - Video Search
            - Product Catalog
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
          description: Display description from display_config
        logo_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Logo Url
          description: Logo URL from display_config
        icon_base64:
          anyOf:
            - type: string
            - type: 'null'
          title: Icon Base64
          description: Base64 encoded icon/favicon from display_config
        og_image_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Og Image Url
          description: Social preview/OG image URL from display_config
        password_protected:
          type: boolean
          title: Password Protected
          description: Whether password authentication is required
        is_active:
          type: boolean
          title: Is Active
          description: Whether the retriever is active
        external_links:
          items:
            $ref: '#/components/schemas/ExternalLink'
          type: array
          title: External Links
          description: External resource links (GitHub, blog posts, docs, etc.)
        created_at:
          type: string
          format: date-time
          title: Created At
          description: When the retriever was published
        updated_at:
          type: string
          format: date-time
          title: Updated At
          description: When the retriever was last updated
      type: object
      required:
        - public_name
        - public_url
        - title
        - password_protected
        - is_active
        - created_at
        - updated_at
      title: PublicRetrieverListItem
      description: |-
        Simplified retriever information for public listing.

        Provides essential details for browsing public retrievers without
        exposing sensitive configuration or credentials.
    PublicRetrieverListStats:
      properties:
        total_active:
          type: integer
          title: Total Active
          description: Number of active public retrievers
          default: 0
        total_password_protected:
          type: integer
          title: Total Password Protected
          description: Number of password-protected retrievers
          default: 0
        total_open:
          type: integer
          title: Total Open
          description: Number of fully open (no password) retrievers
          default: 0
      type: object
      title: PublicRetrieverListStats
      description: Aggregate statistics for public retrievers list.
    ErrorDetail:
      properties:
        message:
          type: string
          title: Message
          description: Human-readable error message
        type:
          type: string
          title: Type
          description: Stable error type identifier (machine-readable)
        code:
          anyOf:
            - type: string
            - type: 'null'
          title: Code
          description: >-
            Fine-grained error code for programmatic handling (e.g.,
            namespace_name_taken, feature_extractor_not_found). Present only
            when consumers may need to branch on a specific error condition.
        details:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Details
          description: >-
            Optional structured details to help debugging (validation errors,
            IDs, etc.)
      type: object
      required:
        - message
        - type
      title: ErrorDetail
      description: Error detail model.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    ExternalLink:
      properties:
        name:
          type: string
          maxLength: 100
          minLength: 1
          title: Name
          description: Display name for the link
          examples:
            - GitHub Repository
            - Blog Post
            - Documentation
            - Demo Video
        url:
          type: string
          maxLength: 2048
          minLength: 1
          title: Url
          description: URL to the external resource
          examples:
            - https://github.com/org/repo
            - https://blog.example.com/post
            - https://docs.example.com
      type: object
      required:
        - name
        - url
      title: ExternalLink
      description: |-
        External resource link for a published retriever.

        Used to link to related resources like GitHub repos, blog posts,
        documentation, or other relevant URLs displayed on the homepage.
      examples:
        - name: GitHub Repository
          url: https://github.com/mixpeek/video-search
        - name: Blog Post
          url: https://blog.mixpeek.com/building-semantic-search

````