Forgot Password

POST

/api/v1/auth/forgot-password

curl --request POST \
  --url https://example.com/api/v1/auth/forgot-password \
  --header 'Content-Type: application/json' \
  --data '{ "email": "[email protected]" }'

Send a password reset email

Request Body ^required

Media type application/json

ForgotPasswordRequest

Request to initiate password reset.

object

email

required

Email

string format: email

Example ^generated

{
  "email": "[email protected]"
}

Responses

200

Successful Response

Media type application/json

ForgotPasswordResponse

Response after initiating password reset.

object

message

required

Message

string

Example ^generated

{
  "message": "example"
}

400

Invalid request

Media type application/json

APIErrorPayload

Canonical API error envelope returned by the API.

object

code

required

Code

HTTP status code

integer

Allowed values: 400 401 403 404 409 422 426 429 500 502 504

detail

required

Detail

Human-readable error message

string

errors

Any of:

Array<object>

Array<object>

ValidationErrorItem

object

loc

required

Loc

Where the validation error occurred

Array

msg

required

Msg

Human-readable validation message

string

type

required

Type

Machine-readable validation error type

string

null

null

type

required

Type

Stable machine-readable error type

string

Allowed values: already_exists_error app_error authentication_error conflict_error aws_error configuration_error database_error dynamodb_error e2b_error e2b_rate_limit_error expired_signature_error expired_token_error forbidden_error group_error invalid_error invalid_flag_error invalid_username_error mail_error member_exists_error member_limit_exceeded_error migration_lock_timeout_error not_found_error oauth_config_error org_sandbox_capacity_exceeded_error bad_gateway_error gateway_timeout_error s3_error server_error task_error stripe_error token_error upgrade_required_error usage_limit_exceeded_error user_verification_error validation_error

Example

{
  "code": 401,
  "detail": "Authentication failed",
  "type": "authentication_error"
}

401

Authentication failed

Media type application/json

APIErrorPayload

Canonical API error envelope returned by the API.

object

code

required

Code

HTTP status code

integer

Allowed values: 400 401 403 404 409 422 426 429 500 502 504

detail

required

Detail

Human-readable error message

string

errors

Any of:

Array<object>

Array<object>

ValidationErrorItem

object

loc

required

Loc

Where the validation error occurred

Array

msg

required

Msg

Human-readable validation message

string

type

required

Type

Machine-readable validation error type

string

null

null

type

required

Type

Stable machine-readable error type

string

Allowed values: already_exists_error app_error authentication_error conflict_error aws_error configuration_error database_error dynamodb_error e2b_error e2b_rate_limit_error expired_signature_error expired_token_error forbidden_error group_error invalid_error invalid_flag_error invalid_username_error mail_error member_exists_error member_limit_exceeded_error migration_lock_timeout_error not_found_error oauth_config_error org_sandbox_capacity_exceeded_error bad_gateway_error gateway_timeout_error s3_error server_error task_error stripe_error token_error upgrade_required_error usage_limit_exceeded_error user_verification_error validation_error

Example

{
  "code": 401,
  "detail": "Authentication failed",
  "type": "authentication_error"
}

403

Access forbidden

Media type application/json

APIErrorPayload

Canonical API error envelope returned by the API.

object

code

required

Code

HTTP status code

integer

Allowed values: 400 401 403 404 409 422 426 429 500 502 504

detail

required

Detail

Human-readable error message

string

errors

Any of:

Array<object>

Array<object>

ValidationErrorItem

object

loc

required

Loc

Where the validation error occurred

Array

msg

required

Msg

Human-readable validation message

string

type

required

Type

Machine-readable validation error type

string

null

null

type

required

Type

Stable machine-readable error type

string

Allowed values: already_exists_error app_error authentication_error conflict_error aws_error configuration_error database_error dynamodb_error e2b_error e2b_rate_limit_error expired_signature_error expired_token_error forbidden_error group_error invalid_error invalid_flag_error invalid_username_error mail_error member_exists_error member_limit_exceeded_error migration_lock_timeout_error not_found_error oauth_config_error org_sandbox_capacity_exceeded_error bad_gateway_error gateway_timeout_error s3_error server_error task_error stripe_error token_error upgrade_required_error usage_limit_exceeded_error user_verification_error validation_error

Example

{
  "code": 401,
  "detail": "Authentication failed",
  "type": "authentication_error"
}

404

Not found

Media type application/json

APIErrorPayload

Canonical API error envelope returned by the API.

object

code

required

Code

HTTP status code

integer

Allowed values: 400 401 403 404 409 422 426 429 500 502 504

detail

required

Detail

Human-readable error message

string

errors

Any of:

Array<object>

Array<object>

ValidationErrorItem

object

loc

required

Loc

Where the validation error occurred

Array

msg

required

Msg

Human-readable validation message

string

type

required

Type

Machine-readable validation error type

string

null

null

type

required

Type

Stable machine-readable error type

string

Allowed values: already_exists_error app_error authentication_error conflict_error aws_error configuration_error database_error dynamodb_error e2b_error e2b_rate_limit_error expired_signature_error expired_token_error forbidden_error group_error invalid_error invalid_flag_error invalid_username_error mail_error member_exists_error member_limit_exceeded_error migration_lock_timeout_error not_found_error oauth_config_error org_sandbox_capacity_exceeded_error bad_gateway_error gateway_timeout_error s3_error server_error task_error stripe_error token_error upgrade_required_error usage_limit_exceeded_error user_verification_error validation_error

Example

{
  "code": 401,
  "detail": "Authentication failed",
  "type": "authentication_error"
}

409

Already exists

Media type application/json

APIErrorPayload

Canonical API error envelope returned by the API.

object

code

required

Code

HTTP status code

integer

Allowed values: 400 401 403 404 409 422 426 429 500 502 504

detail

required

Detail

Human-readable error message

string

errors

Any of:

Array<object>

Array<object>

ValidationErrorItem

object

loc

required

Loc

Where the validation error occurred

Array

msg

required

Msg

Human-readable validation message

string

type

required

Type

Machine-readable validation error type

string

null

null

type

required

Type

Stable machine-readable error type

string

Allowed values: already_exists_error app_error authentication_error conflict_error aws_error configuration_error database_error dynamodb_error e2b_error e2b_rate_limit_error expired_signature_error expired_token_error forbidden_error group_error invalid_error invalid_flag_error invalid_username_error mail_error member_exists_error member_limit_exceeded_error migration_lock_timeout_error not_found_error oauth_config_error org_sandbox_capacity_exceeded_error bad_gateway_error gateway_timeout_error s3_error server_error task_error stripe_error token_error upgrade_required_error usage_limit_exceeded_error user_verification_error validation_error

Example

{
  "code": 401,
  "detail": "Authentication failed",
  "type": "authentication_error"
}

422

Validation error

Media type application/json

APIErrorPayload

Canonical API error envelope returned by the API.

object

code

required

Code

HTTP status code

integer

Allowed values: 400 401 403 404 409 422 426 429 500 502 504

detail

required

Detail

Human-readable error message

string

errors

Any of:

Array<object>

Array<object>

ValidationErrorItem

object

loc

required

Loc

Where the validation error occurred

Array

msg

required

Msg

Human-readable validation message

string

type

required

Type

Machine-readable validation error type

string

null

null

type

required

Type

Stable machine-readable error type

string

Allowed values: already_exists_error app_error authentication_error conflict_error aws_error configuration_error database_error dynamodb_error e2b_error e2b_rate_limit_error expired_signature_error expired_token_error forbidden_error group_error invalid_error invalid_flag_error invalid_username_error mail_error member_exists_error member_limit_exceeded_error migration_lock_timeout_error not_found_error oauth_config_error org_sandbox_capacity_exceeded_error bad_gateway_error gateway_timeout_error s3_error server_error task_error stripe_error token_error upgrade_required_error usage_limit_exceeded_error user_verification_error validation_error

Example

{
  "code": 401,
  "detail": "Authentication failed",
  "type": "authentication_error"
}

426

Upgrade required

Media type application/json

APIErrorPayload

Canonical API error envelope returned by the API.

object

code

required

Code

HTTP status code

integer

Allowed values: 400 401 403 404 409 422 426 429 500 502 504

detail

required

Detail

Human-readable error message

string

errors

Any of:

Array<object>

Array<object>

ValidationErrorItem

object

loc

required

Loc

Where the validation error occurred

Array

msg

required

Msg

Human-readable validation message

string

type

required

Type

Machine-readable validation error type

string

null

null

type

required

Type

Stable machine-readable error type

string

Allowed values: already_exists_error app_error authentication_error conflict_error aws_error configuration_error database_error dynamodb_error e2b_error e2b_rate_limit_error expired_signature_error expired_token_error forbidden_error group_error invalid_error invalid_flag_error invalid_username_error mail_error member_exists_error member_limit_exceeded_error migration_lock_timeout_error not_found_error oauth_config_error org_sandbox_capacity_exceeded_error bad_gateway_error gateway_timeout_error s3_error server_error task_error stripe_error token_error upgrade_required_error usage_limit_exceeded_error user_verification_error validation_error

Example

{
  "code": 401,
  "detail": "Authentication failed",
  "type": "authentication_error"
}

429

Rate limited

Media type application/json

APIErrorPayload

Canonical API error envelope returned by the API.

object

code

required

Code

HTTP status code

integer

Allowed values: 400 401 403 404 409 422 426 429 500 502 504

detail

required

Detail

Human-readable error message

string

errors

Any of:

Array<object>

Array<object>

ValidationErrorItem

object

loc

required

Loc

Where the validation error occurred

Array

msg

required

Msg

Human-readable validation message

string

type

required

Type

Machine-readable validation error type

string

null

null

type

required

Type

Stable machine-readable error type

string

Allowed values: already_exists_error app_error authentication_error conflict_error aws_error configuration_error database_error dynamodb_error e2b_error e2b_rate_limit_error expired_signature_error expired_token_error forbidden_error group_error invalid_error invalid_flag_error invalid_username_error mail_error member_exists_error member_limit_exceeded_error migration_lock_timeout_error not_found_error oauth_config_error org_sandbox_capacity_exceeded_error bad_gateway_error gateway_timeout_error s3_error server_error task_error stripe_error token_error upgrade_required_error usage_limit_exceeded_error user_verification_error validation_error

Example

{
  "code": 401,
  "detail": "Authentication failed",
  "type": "authentication_error"
}

500

Internal server error

Media type application/json

APIErrorPayload

Canonical API error envelope returned by the API.

object

code

required

Code

HTTP status code

integer

Allowed values: 400 401 403 404 409 422 426 429 500 502 504

detail

required

Detail

Human-readable error message

string

errors

Any of:

Array<object>

Array<object>

ValidationErrorItem

object

loc

required

Loc

Where the validation error occurred

Array

msg

required

Msg

Human-readable validation message

string

type

required

Type

Machine-readable validation error type

string

null

null

type

required

Type

Stable machine-readable error type

string

Allowed values: already_exists_error app_error authentication_error conflict_error aws_error configuration_error database_error dynamodb_error e2b_error e2b_rate_limit_error expired_signature_error expired_token_error forbidden_error group_error invalid_error invalid_flag_error invalid_username_error mail_error member_exists_error member_limit_exceeded_error migration_lock_timeout_error not_found_error oauth_config_error org_sandbox_capacity_exceeded_error bad_gateway_error gateway_timeout_error s3_error server_error task_error stripe_error token_error upgrade_required_error usage_limit_exceeded_error user_verification_error validation_error

Example

{
  "code": 401,
  "detail": "Authentication failed",
  "type": "authentication_error"
}

502

Bad gateway

Media type application/json

APIErrorPayload

Canonical API error envelope returned by the API.

object

code

required

Code

HTTP status code

integer

Allowed values: 400 401 403 404 409 422 426 429 500 502 504

detail

required

Detail

Human-readable error message

string

errors

Any of:

Array<object>

Array<object>

ValidationErrorItem

object

loc

required

Loc

Where the validation error occurred

Array

msg

required

Msg

Human-readable validation message

string

type

required

Type

Machine-readable validation error type

string

null

null

type

required

Type

Stable machine-readable error type

string

Allowed values: already_exists_error app_error authentication_error conflict_error aws_error configuration_error database_error dynamodb_error e2b_error e2b_rate_limit_error expired_signature_error expired_token_error forbidden_error group_error invalid_error invalid_flag_error invalid_username_error mail_error member_exists_error member_limit_exceeded_error migration_lock_timeout_error not_found_error oauth_config_error org_sandbox_capacity_exceeded_error bad_gateway_error gateway_timeout_error s3_error server_error task_error stripe_error token_error upgrade_required_error usage_limit_exceeded_error user_verification_error validation_error

Example

{
  "code": 401,
  "detail": "Authentication failed",
  "type": "authentication_error"
}

504

Gateway timeout

Media type application/json

APIErrorPayload

Canonical API error envelope returned by the API.

object

code

required

Code

HTTP status code

integer

Allowed values: 400 401 403 404 409 422 426 429 500 502 504

detail

required

Detail

Human-readable error message

string

errors

Any of:

Array<object>

Array<object>

ValidationErrorItem

object

loc

required

Loc

Where the validation error occurred

Array

msg

required

Msg

Human-readable validation message

string

type

required

Type

Machine-readable validation error type

string

null

null

type

required

Type

Stable machine-readable error type

string

Allowed values: already_exists_error app_error authentication_error conflict_error aws_error configuration_error database_error dynamodb_error e2b_error e2b_rate_limit_error expired_signature_error expired_token_error forbidden_error group_error invalid_error invalid_flag_error invalid_username_error mail_error member_exists_error member_limit_exceeded_error migration_lock_timeout_error not_found_error oauth_config_error org_sandbox_capacity_exceeded_error bad_gateway_error gateway_timeout_error s3_error server_error task_error stripe_error token_error upgrade_required_error usage_limit_exceeded_error user_verification_error validation_error

Example

{
  "code": 401,
  "detail": "Authentication failed",
  "type": "authentication_error"
}