Skip to main content
POST
/
vault
/
generate-password
cURL
curl --request POST \
  --url https://api.useanima.sh/v1/vault/generate-password \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agentId": "<string>",
  "length": 66,
  "uppercase": true,
  "lowercase": true,
  "number": true,
  "special": true
}
'
{
  "password": "<string>"
}

Authorizations

Authorization
string
header
required

JWT Bearer token obtained from authentication. Pass as: Authorization: Bearer

Body

application/json

Input for generating a random password

agentId

Agent identifier. Optional when using an agent API key (resolved automatically); required when using a master key.

Pattern: ^[0-9a-z]+$
length
integer

Desired password length (4-128 characters)

Required range: 4 <= x <= 128
uppercase
boolean

Include uppercase letters

lowercase
boolean

Include lowercase letters

number
boolean

Include numeric digits

special
boolean

Include special characters

Response

200 - application/json

OK

Generated password result

password
string
required

The generated password