Skip to main content
POST
Verify Password

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.