Skip to main content
Endpoints to retrieve and modify tenant settings — personality, widget, security, and integrations.

​
GET /tenants/

Retrieve tenant information. Required scope: settings:read

​
Request

curl https://api.animam.ai/tenants/my-company \
  -H "Authorization: Bearer ak_your_token"

​
Response

{
  "id": "clx1234567890",
  "slug": "my-company",
  "name": "My Company",
  "plan": "pro",
  "isActivated": true,
  "botName": "Sophie",
  "botTitle": "Customer Assistant",
  "botTone": "FRIENDLY",
  "useTutoiement": false,
  "allowEmojis": true,
  "primaryColor": "#6366f1",
  "showAiBadge": true,
  "allowedDomains": ["*.mycompany.com"],
  "contentPolicy": "SFW",
  "conversationsUsed": 42,
  "conversationsLimit": 2000,
  "createdAt": "2024-01-15T10:30:00Z"
}

​
PUT /tenants/

Modify tenant settings. Send only the fields you want to update. Required scope: settings:write

​
Request

curl -X PUT https://api.animam.ai/tenants/my-company \
  -H "Authorization: Bearer ak_your_token" \
  -H "Content-Type: application/json" \
  -d '{
    "botName": "Emma",
    "botTone": "FRIENDLY",
    "primaryColor": "#2563eb",
    "allowedDomains": ["*.mycompany.com", "localhost:3000"]
  }'

​
Response

Returns the full updated tenant object.

​
Modifiable fields

​
Personality

FieldTypeDescription
namestringTenant display name
botNamestringBot name shown in widget header
botTitlestringSubtitle under bot name
botLorestringBackground story (injected in system prompt)
botTonestringFORMAL, NEUTRAL, FRIENDLY, PLAYFUL, TECHNICAL
useTutoiementbooleanUse “tu” instead of “vous” (French bots)
allowEmojisbooleanAllow emojis in responses

​
Appearance

FieldTypeDescription
primaryColorstringHex color for widget UI
secondaryColorstringSecondary hex color
showAiBadgebooleanShow “AI” badge in widget
botAvatarstringAvatar image URL
avatarTypestringDEFAULT, UPLOAD, LIBRARY, GENERATED

​
Security

FieldTypeDescription
allowedDomainsstring[]CORS whitelist for widget. Empty = allow all. Supports exact match, bare domain, and wildcard (*.example.com)
contentPolicystringSFW_STRICT, SFW (default), MODERATE, UNFILTERED
visitorAuthModestring|nulljwt, otp, all, or null (disabled)
turnstileEnabledbooleanEnable Cloudflare Turnstile CAPTCHA
turnstileSiteKeystringTurnstile site key
turnstileSecretKeystringTurnstile secret key

​
Booking CTA

FieldTypeDescription
bookingCtaEnabledbooleanEnable booking CTA in welcome screen
bookingCtaConfigobjectCTA configuration (headline, subtitle, CTA text, office hours)

​
Status

FieldTypeDescription
isOnboardedbooleanMark onboarding as complete

​
GET /tenants//stats

Retrieve usage statistics. Required scope: settings:read

​
Request

curl https://api.animam.ai/tenants/my-company/stats \
  -H "Authorization: Bearer ak_your_token"