# Anima — LLM-Friendly Documentation Index
# This file helps LLMs understand the Anima platform and find relevant documentation.
# Spec: https://llmstxt.org

> Anima is the unified identity layer for AI agents. One agent, every channel: email, phone, voice, vault, addresses, and a unified policy engine — all under one verified identity.

## Overview

Anima gives autonomous agents a real, verified identity. Instead of bolting Mailgun + Twilio + Bitwarden together, Anima provides every channel under one API with a single identity primitive, one policy engine, and one approval surface for the human in the loop.

**Quickest path to Anima:**

In any MCP-aware agent (Claude Code, Cursor, Codex, OpenClaw, Windsurf), paste:

```
Read useanima.sh/skill.md and get me set up with Anima
```

Or run:

```bash
npm install -g @anima-labs/cli && anima onboard
```

## Surfaces

- `useanima.sh` — marketing + docs
- `app.useanima.sh` — main app (humans manage their agents)
- `console.useanima.sh` — operator console (dashboards)
- `connect.useanima.sh` — OAuth consent (third-party agents request scopes against a user's Anima identity)
- `api.useanima.sh` — REST API + MCP HTTP server
- `docs.useanima.sh` — developer documentation

## Docs

- [Getting Started](https://docs.useanima.sh/getting-started): Quick setup — agent identity in 5 minutes
- [Skill manifest](https://useanima.sh/skill.md): Agent-readable skill for self-onboarding
- [Vault](https://docs.useanima.sh/vault): Secure credential storage with egress-time injection
- [Custom email domains](https://docs.useanima.sh/custom-domains): Bring your own domain for agent inboxes
- [Protocols overview](https://docs.useanima.sh/protocols): Google AP2 and emerging agent identity protocols
- [Google AP2](https://docs.useanima.sh/protocols/ap2): Agent Payment Protocol v2
- [MCP integration](https://docs.useanima.sh/mcp): MCP server for Claude, Codex, Cursor, Windsurf, Zed
- [SDKs](https://docs.useanima.sh/sdks): TypeScript / Python / Go reference
- [Webhooks](https://docs.useanima.sh/webhooks): Real-time event notifications (HMAC-SHA256, replay-window)
- [Security](https://docs.useanima.sh/security): SOC 2 Type II, encryption, audit logging
- [Encryption details](https://docs.useanima.sh/encryption): AES-256-GCM, envelope encryption, KEK rotation
- [Secret references](https://docs.useanima.sh/secret-ref): Egress-time vault injection
- [API Reference](https://api.useanima.sh/docs): OpenAPI 3.1 specification
- [FAQ](https://docs.useanima.sh/faq): Frequently asked questions

### Coming soon (long-form docs)

These reference docs are being written. Until they ship, refer to the [skill manifest](https://useanima.sh/skill.md) and the [CLI README on GitHub](https://github.com/anima-labs-ai/cli).

- `/docs/cli` — full CLI reference
- `/docs/cli/onboard` — guided onboarding flow
- `/docs/email`, `/docs/phone`, `/docs/voice` — channel-specific guides
- `/docs/oauth` — Anima Connect (consumer OAuth grants)

## API

Base URL: `https://api.useanima.sh`

Authentication: API key via `Authorization: Bearer ak_…` (agent key) or `mk_…` (master key) header. Or OAuth bearer for consumer-mode access via `connect.useanima.sh`.

### Key endpoints

- `POST /v1/agent/sign-up` — Self-onboard a new agent identity (no auth)
- `POST /v1/identities` — Create a new agent identity (auth required)
- `GET /v1/identities/:id` — Get identity details
- `POST /v1/emails` — Send email
- `GET /v1/emails` — List inbox messages
- `POST /v1/sms` — Send SMS
- `POST /v1/voice/calls` — Place an outbound voice call (gated by TCPA + RND + time-of-day)
- `POST /v1/vault/credentials` — Store credential
- `GET /v1/vault/credentials/:id/handle` — Get ephemeral handle for egress-time injection

### MCP tools

Anima exposes 190+ capabilities as MCP tools. Core set:

- `whoami` — current agent identity + cli update info
- `agent_create`, `agent_get`, `agent_list`, `agent_update` — identity lifecycle
- `email_send`, `email_list`, `email_search`, `inbox_digest` — email
- `phone_provision`, `phone_send_sms`, `phone_status` — phone / SMS
- `voice_create_call`, `voice_get_transcript` — voice
- `vault_create_credential`, `vault_get_credential`, `vault_get_totp` — vault
- `webhook_create`, `webhook_test` — event subscriptions
- `browser_detect_checkout`, `browser_pay_checkout` — Chrome extension automation

Full tool index: [docs.useanima.sh/mcp](https://docs.useanima.sh/mcp).

## CLI output: agent vs human

Anima CLI defaults to **agent format** (compact single-line JSON, ~30-40% smaller than pretty JSON, fewer tokens to parse). Pass `--human` for box-drawn tables.

```bash
anima email list                 # agent default: {"items":[…]}
anima email list --human         # ┌── pretty table
anima email list --format yaml   # explicit yaml
anima email list --format jsonl  # one record per line
anima email list --format md     # markdown table
```

Errors are emitted as JSON `{"status":"error","message":"…"}` on stderr with exit code 1.

`anima auth whoami` includes an `update` field when a newer CLI version is available — agents can branch on `update !== undefined` to surface upgrade prompts.

## Code examples

### TypeScript SDK
```typescript
import { Anima } from '@anima/sdk';

const client = new Anima({ apiKey: 'ak_…' });

// Create an identity
const identity = await client.identities.create({
  name: 'support-agent',
  capabilities: ['email', 'phone', 'voice', 'vault'],
});

// Send email
await client.emails.send({
  identityId: identity.id,
  to: 'customer@example.com',
  subject: 'Welcome',
  text: 'Your agent identity is live.',
});

// Place an outbound voice call (TCPA + RND + time-of-day gates run server-side)
await client.voice.calls.create({
  identityId: identity.id,
  to: '+15551234567',
  consentSource: 'opt-in:web-form',
  script: 'Hello! This is your support assistant.',
});
```

### CLI
```bash
# Onboard end-to-end
anima onboard

# Send email
anima email send --to merchant@example.com --subject "Hello" --text "Hi"

# Place a voice call
anima voice place --to +15551234567 --consent opt-in:web-form --script "Hello"
```

## Pricing

- **Free**: 3 identities, 3,000 emails/mo, vault + MCP, no telephony — $0/mo
- **Starter**: 25 identities, 25K emails/mo, 1 phone number, voice — $19/mo
- **Growth**: 250 identities, 250K emails/mo, 10 phone numbers, voice — $199/mo
- **Enterprise**: Unlimited identities, OAuth consumer mode (Anima Connect), priority support, custom pricing

## Optional

- [Comparison: Anima vs DIY stack](https://useanima.sh/compare/diy)
- [Comparison: Anima vs Proxy.ai](https://useanima.sh/compare/proxy)
- [Blog](https://useanima.sh/blog)
- [Changelog](https://useanima.sh/changelog)
- [Status](https://status.useanima.sh)
- [Discord](https://discord.gg/pY3GK59Z9E)