Verify Password
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:
- Frontend detects that a retriever is password-protected (from /config endpoint)
- User enters password in the UI
- Frontend calls this endpoint to verify the password
- If valid, frontend receives the public_api_key to use for subsequent requests
Response:
valid: Whether the password is correctpublic_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
Verify Password
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.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Public name of the published retriever
Body
application/json
Request to verify password for a password-protected retriever.
The password to verify against the retriever's password
Minimum string length:
1