---
title: "POST /vault/generate-password"
method: POST
path: "/vault/generate-password"
---

# POST /vault/generate-password

`POST /vault/generate-password`

## Request

- Base URL: `https://api.useanima.sh/v1`
- URL: `https://api.useanima.sh/v1/vault/generate-password`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

## Request body

- object: Input for generating a random password
  - `agentId` union: Agent identifier. Optional when using an agent API key (resolved automatically); required when using a master key.
    - string
    - string
  - `length` integer: Desired password length (4-128 characters)
  - `uppercase` boolean: Include uppercase letters
  - `lowercase` boolean: Include lowercase letters
  - `number` boolean: Include numeric digits
  - `special` boolean: Include special characters

## Response `200`

OK

- object: Generated password result
  - `password` string, required: The generated password

---

[API](https://skmtc.dev/useanima/apis/anima-api.md) · [All operations](https://skmtc.dev/useanima/apis/anima-api/llms.txt) · [OpenAPI document](https://skmtc.dev/useanima/apis/anima-api/revisions/aaa148188980?raw)