Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

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

Body

application/json

Provision a complete agent identity in a single call

name
string
required

Human-readable name for the agent (e.g. 'shopping-agent')

Required string length: 2 - 100
capabilities
enum<string>[]
required

Capabilities to provision. Email is always included.

Minimum array length: 1
Available options:
email,
phone,
vault
slug
string

URL-safe identifier. Auto-derived from name if omitted

Required string length: 2 - 64
Pattern: ^[a-z0-9-]+$
email
string<email>

Custom email address. Defaults to {slug}@agents.useanima.sh

phone
object

Phone provisioning options (only used if 'phone' is in capabilities)

metadata
object

Arbitrary key-value metadata

Response

200 - application/json

OK

Provisioned agent identity with all requested capabilities

id
string
required

Agent ID

name
string
required
slug
string
required
apiKey
string
required

Agent API key — only returned on creation

email
object | null
required

Email identity (always provisioned)

phone
object | null
required

Phone identity (if requested)

vault
object | null
required

Vault identity (if requested)

failures
object[]
required

Capabilities that failed to provision. Empty on full success.

createdAt
string<date-time>
required