---
title: "POST /agent/sign-up"
method: POST
path: "/agent/sign-up"
---

# POST /agent/sign-up

`POST /agent/sign-up`

## Request

- Base URL: `https://api.useanima.sh/v1`
- URL: `https://api.useanima.sh/v1/agent/sign-up`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

## Request body

- object: Self-service agent sign-up — no human required
  - `human_email` string, email, required: Your human's email address — used for verification and claiming
  - `username` string, required: Preferred inbox username (e.g. 'my-agent' → 'my-agent@agents.useanima.sh')
  - `name` string: Display name for the agent. Defaults to username if omitted
  - `provision_vault` boolean: Provision an encrypted vault for the new agent as part of sign-up. This is the only way a self-service agent can obtain a first vault: `vault.provision` is master-gated, and sign-up never discloses the master key. Safe here precisely because the org is being created by this same call — there is no existing privilege to escalate from.
  - `source` 'smithery' | 'cline' | 'dxt' | 'open-mcp' | 'cli' | 'skill-md' | 'web' | 'unknown': Channel that produced this sign-up (e.g. 'smithery'). Optional; defaults to 'unknown'. Unrecognised values coerce rather than fail.

## Response `200`

OK

- object: Sign-up response with credentials
  - `agent_id` string, required: Your agent ID
  - `organization_id` string, required: Your organization ID
  - `inbox_id` string, required: Your email address (e.g. 'my-agent@agents.useanima.sh')
  - `api_key` string, required: Your API key — save this immediately, it won't be shown again
  - `auth_type` 'agent_unverified' | 'agent_verified' | 'claimed', required: Current verification status
  - `vault_id` string, nullable, required: Vault identity id when `provision_vault` was requested and granted, else null. Null with provision_vault=true means the vault feature is off on this deployment — sign-up still succeeded.

---

[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)
