Skip to main content
POST
/
agent
/
sign-up
cURL
curl --request POST \
  --url https://api.useanima.sh/v1/agent/sign-up \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "human_email": "jsmith@example.com",
  "username": "<string>",
  "name": "<string>"
}
'
{
  "agent_id": "<string>",
  "organization_id": "<string>",
  "inbox_id": "<string>",
  "api_key": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

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@anima.email')

Required string length: 2 - 64
Pattern: ^[a-z0-9-]+$
​
name
string

Display name for the agent. Defaults to username if omitted

Required string length: 2 - 100

Response

200 - application/json

OK

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@anima.email')

​
api_key
string
required

Your API key — save this immediately, it won't be shown again

​
auth_type
enum<string>
required

Current verification status

Available options:
agent_unverified,
agent_verified,
claimed