Generate Passphrase

curl --request GET \
  --url https://api.example.com/v1/password/generate-passphrase \
  --header 'X-API-Key: <api-key>'

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

GET

password

generate-passphrase

Generate Passphrase

curl --request GET \
  --url https://api.example.com/v1/password/generate-passphrase \
  --header 'X-API-Key: <api-key>'

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

X-API-Key

string

header

required

words

integer

default:4

Number of words

Required range: 2 <= x <= 10

separator

string

default:-

Word separator

capitalize

boolean

default:false

Capitalize each word

include_number

boolean

default:false

Include a random number

Successful Response