---
title: "Get tenant info and settings"
method: GET
path: "/tenants/{slug}"
tags: ["tenants"]
---

# Get tenant info and settings

`GET /tenants/{slug}`

## Request

- Base URL: `https://api.animam.ai`
- URL: `https://api.animam.ai/tenants/{slug}`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`
  - OAuth 2 (authorization code, authorization URL `https://api.animam.ai/oauth/authorize`, token URL `https://api.animam.ai/oauth/token`, scopes: `settings:read`)

## Path parameters

- `slug` string, required: Tenant slug (URL-safe identifier).

## Response `200`

Tenant info, persona, plan, recent conversations.

- object
  - `tenant` object, required
    - `slug` string
    - `name` string
    - `botName` string, nullable
    - `botTitle` string, nullable
    - `botLore` string, nullable
    - `botTone` 'FORMAL' | 'NEUTRAL' | 'FRIENDLY' | 'PLAYFUL' | 'TECHNICAL'
    - `useTutoiement` boolean
    - `allowEmojis` boolean
    - `botAvatar` string, nullable
    - `avatarType` string, nullable
    - `avatarBackground` string, nullable
    - `primaryColor` string
    - `secondaryColor` string, nullable
    - `showAiBadge` boolean
    - `plan` string
    - `conversationsLimit` integer
    - `conversationsUsed` integer
    - `segmentsLimit` integer
    - `corpusLimit` integer
    - `allowedDomains` string[]
    - `contentPolicy` 'SFW_STRICT' | 'SFW' | 'MODERATE' | 'UNFILTERED'
    - `mcpToolsUrl` string, nullable
    - `mcpToolsMaxTools` integer
  - `stats` object, required
    - `corpusCount` integer, required
    - `segmentCount` integer, required
    - `conversationCount` integer, required
    - `conversationsRemaining` integer, required
  - `recentConversations` unknown[], required
    - unknown
  - `embedCode` string, required

---

[API](https://skmtc.dev/animam/apis/animam-api.md) · [All operations](https://skmtc.dev/animam/apis/animam-api/llms.txt) · [OpenAPI document](https://skmtc.dev/animam/apis/animam-api/revisions/138c3cf374f1?raw)