Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.animam.ai/llms.txt

Use this file to discover all available pages before exploring further.

Understanding the fundamental concepts of Animam.

​
Tenant

A tenant represents your Animam account. Each tenant has:
  • A unique slug (e.g., my-company)
  • A corpus (knowledge base)
  • Segments (contexts)
  • A configurable personality

​
Corpus

The corpus is your chatbot’s knowledge base. It’s the content it uses to answer questions. Each corpus entry has:
  • A title (for organization)
  • Content (the text the bot knows)
  • An optional segment (for context)
  • A priority (high-priority entries are preferred)
Write your corpus as if you were talking to a customer. The bot naturally adopts this tone.

​
Segments

Segments allow different contexts for different pages. Example:
  • Segment landing: general questions about your product
  • Segment pricing: questions about pricing
  • Segment support: technical questions
<!-- Home page -->
<script src="https://animam.ai/widget.js" data-tenant="my-site" data-segment="landing"></script>

<!-- Pricing page -->
<script src="https://animam.ai/widget.js" data-tenant="my-site" data-segment="pricing"></script>

​
Personality

The personality defines how the bot expresses itself:
ParameterDescription
NameThe bot’s name (e.g., “Alice”, “Support”)
TitleIts role (e.g., “Sales Assistant”)
LoreIts background/context
ToneProfessional, casual, friendly
FormalityFormal or informal address
EmojisAllowed or not

​
API Tokens

API tokens allow programmatic API access. Each token has scopes (permissions):
  • corpus:read / corpus:write
  • conversations:read
  • settings:read / settings:write
  • * (full access)
Tokens are only displayed once at creation. Store them securely.

​
Bridges

Bridges are how the agent acts on third-party systems without building a parallel data store. Instead of capturing leads, orders or subscriptions in an Animam-owned table, the agent calls the system the tenant already runs and lets it persist the data — so existing automations (Zapier, notification emails, CRM connectors) keep firing untouched. Today three bridges ship in the WordPress plugin:
BridgeWhat the agent doesWhere data lands
WPFormsSubmits the form on behalf of the visitor through the native WPForms pipelineWPForms entries (existing automations preserved)
WooCommerceSearches products, adds to cart; checkout stays nativeWooCommerce orders
MailPoetSubscribes the visitor to whitelisted lists, double opt-in preservedMailPoet subscribers
Bridges live inside the destination system — Animam never owns the data and the tenant can audit what the agent did inside WPForms entries, WooCommerce orders or MailPoet subscribers like any other action.

​
Connectors

Connectors authenticate the agent into outbound services so the chatbot can act on the tenant’s behalf. Today the platform ships connectors for Google Calendar (BOOK_MEETING + CHECK_AVAILABILITY) and Stripe (COLLECT_PAYMENT). Each connector auto-injects the tools it powers into the agent’s toolbelt — no manual configuration needed once OAuth or API keys are linked.

​
Multi-tenant (Enterprise)

In Enterprise mode, you can create child tenants:
  • A parent dashboard to manage everything
  • Independent child chatbots
  • Complete white-label (no Animam mention)