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

# Verify Password

> Verify password for a password-protected retriever.

Allows the frontend to check if a password is valid before attempting to execute
a password-protected retriever. Returns the public API key if the password is valid.

**Authentication:**
- NO authentication required - this endpoint is public
- The password is verified against the retriever's configured password

**Use Case:**
1. Frontend detects that a retriever is password-protected (from /config endpoint)
2. User enters password in the UI
3. Frontend calls this endpoint to verify the password
4. If valid, frontend receives the public_api_key to use for subsequent requests

**Response:**
- `valid`: Whether the password is correct
- `public_api_key`: The API key to use for execute/interact endpoints (only if valid)

**Example:**
```bash
curl -X POST "https://api.mixpeek.com/v1/public/retrievers/private-search/verify" \
  -H "Content-Type: application/json" \
  -d '{"password": "secret123"}'
```

**Response if valid:**
```json
{
  "valid": true,
  "public_api_key": "prk_abc123..."
}
```

**Response if invalid:**
```json
{
  "valid": false,
  "public_api_key": null
}
```



## OpenAPI

````yaml post /v1/public/retrievers/{public_name}/verify
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/{public_name}/verify:
    post:
      tags:
        - Public Retriever API
      summary: Verify Password
      description: >-
        Verify password for a password-protected retriever.


        Allows the frontend to check if a password is valid before attempting to
        execute

        a password-protected retriever. Returns the public API key if the
        password is valid.


        **Authentication:**

        - NO authentication required - this endpoint is public

        - The password is verified against the retriever's configured password


        **Use Case:**

        1. Frontend detects that a retriever is password-protected (from /config
        endpoint)

        2. User enters password in the UI

        3. Frontend calls this endpoint to verify the password

        4. If valid, frontend receives the public_api_key to use for subsequent
        requests


        **Response:**

        - `valid`: Whether the password is correct

        - `public_api_key`: The API key to use for execute/interact endpoints
        (only if valid)


        **Example:**

        ```bash

        curl -X POST
        "https://api.mixpeek.com/v1/public/retrievers/private-search/verify" \
          -H "Content-Type: application/json" \
          -d '{"password": "secret123"}'
        ```


        **Response if valid:**

        ```json

        {
          "valid": true,
          "public_api_key": "prk_abc123..."
        }

        ```


        **Response if invalid:**

        ```json

        {
          "valid": false,
          "public_api_key": null
        }

        ```
      operationId: verify_password_v1_public_retrievers__public_name__verify_post
      parameters:
        - name: public_name
          in: path
          required: true
          schema:
            type: string
            description: Public name of the published retriever
            title: Public Name
          description: Public name of the published retriever
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VerifyPasswordRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VerifyPasswordResponse'
        '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:
    VerifyPasswordRequest:
      properties:
        password:
          type: string
          minLength: 1
          title: Password
          description: The password to verify against the retriever's password
      type: object
      required:
        - password
      title: VerifyPasswordRequest
      description: Request to verify password for a password-protected retriever.
    VerifyPasswordResponse:
      properties:
        valid:
          type: boolean
          title: Valid
          description: Whether the provided password is valid
        public_api_key:
          anyOf:
            - type: string
            - type: 'null'
          title: Public Api Key
          description: >-
            DEPRECATED: API keys are no longer required. After password
            verification, call the execute endpoint directly.
      type: object
      required:
        - valid
      title: VerifyPasswordResponse
      description: Response from password verification.
    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
    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

````