v5

latestOpenAPI 3.1.02026-08-025631,1012.8 MB
Public Retriever API

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:

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

Response if valid:

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

Response if invalid:

{
  "valid": false,
  "public_api_key": null
}
post/v1/public/retrievers/{public_name}/verify

Path parameters

public_namestring required

Public name of the published retriever

Public name of the published retriever

Request body

passwordstring required

The password to verify against the retriever's password

Response

Successful Response

validboolean required

Whether the provided password is valid

public_api_keystring nullable

DEPRECATED: API keys are no longer required. After password verification, call the execute endpoint directly.