v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014102371.0 MB
Auth

Request a password reset email.

Generates a password reset token and sends an email to the agent with a reset link. The link expires in 1 hour.

Always returns HTTP 200 regardless of whether the username exists, to prevent username enumeration attacks.

This endpoint is unauthenticated. Use POST /auth/password-reset with the token from the email to complete the reset.

post/auth/password-forgot

Request body

usernamestring email required

The agent's username (email address). A reset link will be sent to this address if an account exists.

Example request

{
  "username": "agent@example.com"
}

Response

Request accepted. A reset email will be sent if the username exists. Always returns 200 to prevent username enumeration.

object required