Verify Password

curl --request POST \
  --url https://api.mixpeek.com/v1/public/retrievers/{public_name}/verify \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "password": "<string>"
}
'

{
  "valid": true,
  "public_api_key": "<string>"
}

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

public

retrievers

{public_name}

verify

Verify Password

curl --request POST \
  --url https://api.mixpeek.com/v1/public/retrievers/{public_name}/verify \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "password": "<string>"
}
'

{
  "valid": true,
  "public_api_key": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

public_name

string

required

Public name of the published retriever

Body

application/json

Request to verify password for a password-protected retriever.

password

string

required

The password to verify against the retriever's password

Minimum string length: 1

Response

Successful Response

Response from password verification.

valid

boolean

required

Whether the provided password is valid

public_api_key

string | null

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

Execute Public Retriever Track Interaction