Animam.ai

Animam.ai Tenants API

Tenant settings, persona, MCP tools config.

GitHub OpenAPI

Operations 3

GET /tenants/{slug} Get tenant info and settings #
PUT /tenants/{slug} Update tenant settings #
PUT /tenants/{slug}/mcp-tools Configure external MCP server as tool source #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/animam-ai/openapi/animam-ai-tenants-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/animam-ai/json-schema/animam-ai-create-corpus-body-schema.json
📊
JSONSchema
https://artifacts.apis.io/animam-ai/json-schema/animam-ai-update-tenant-body-schema.json
📊
JSONSchema
https://artifacts.apis.io/animam-ai/json-schema/animam-ai-corpus-entry-schema.json
📊
JSONSchema
https://artifacts.apis.io/animam-ai/json-schema/animam-ai-segment-detail-schema.json
📊
JSONSchema
https://artifacts.apis.io/animam-ai/json-schema/animam-ai-list-corpus-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/animam-ai/json-schema/animam-ai-create-segment-body-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/animam-ai:animam-ai-tenants-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

animam-ai-tenants-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Animam Ai Tenants API
  version: 2.1.0
  contact:
    name: Animam
    url: https://animam.ai
  license:
    name: Proprietary
  description: 'Operations tagged tenants across 2 of this provider''s published API definitions: animam-ai-openapi.json, animam-ai-original.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.animam.ai
  description: Production
tags:
- name: Tenants
  description: Tenant settings, persona, MCP tools config.
paths:
  /tenants/{slug}:
    get:
      tags:
      - Tenants
      summary: Get tenant info and settings
      security:
      - bearerAuth: []
      - apiKey: []
      - oauth2:
        - settings:read
      parameters:
      - schema:
          type: string
          description: Tenant slug (URL-safe identifier).
          example: dr-martin
        required: true
        description: Tenant slug (URL-safe identifier).
        name: slug
        in: path
      responses:
        '200':
          description: Tenant info, persona, plan, recent conversations.
          content:
            application/json:
              schema:
                type: object
                properties:
                  tenant:
                    type: object
                    properties:
                      slug:
                        type: string
                      name:
                        type: string
                      botName:
                        type:
                        - string
                        - 'null'
                      botTitle:
                        type:
                        - string
                        - 'null'
                      botLore:
                        type:
                        - string
                        - 'null'
                      botTone:
                        $ref: '#/components/schemas/BotTone'
                      useTutoiement:
                        type: boolean
                      allowEmojis:
                        type: boolean
                      botAvatar:
                        type:
                        - string
                        - 'null'
                      avatarType:
                        type:
                        - string
                        - 'null'
                      avatarBackground:
                        type:
                        - string
                        - 'null'
                      primaryColor:
                        type: string
                      secondaryColor:
                        type:
                        - string
                        - 'null'
                      showAiBadge:
                        type: boolean
                      plan:
                        type: string
                      conversationsLimit:
                        type: integer
                      conversationsUsed:
                        type: integer
                      segmentsLimit:
                        type: integer
                      corpusLimit:
                        type: integer
                      allowedDomains:
                        type: array
                        items:
                          type: string
                      contentPolicy:
                        $ref: '#/components/schemas/ContentPolicy'
                      mcpToolsUrl:
                        type:
                        - string
                        - 'null'
                      mcpToolsMaxTools:
                        type: integer
                  stats:
                    type: object
                    properties:
                      corpusCount:
                        type: integer
                      segmentCount:
                        type: integer
                      conversationCount:
                        type: integer
                      conversationsRemaining:
                        type: integer
                    required:
                    - corpusCount
                    - segmentCount
                    - conversationCount
                    - conversationsRemaining
                  recentConversations:
                    type: array
                    items: {}
                  embedCode:
                    type: string
                required:
                - tenant
                - stats
                - recentConversations
                - embedCode
      operationId: getTenantsBySlug
      x-operation-id-source: derived
    put:
      tags:
      - Tenants
      summary: Update tenant settings
      description: Update bot persona, content policy, and integrations. Schema reflects the MCP-shared subset; additional REST-only fields (turnstile, visitor auth, booking CTA, plan limits) accepted but not yet documented here. See https://animam.ai/llms-full.txt for full reference.
      security:
      - bearerAuth: []
      - apiKey: []
      - oauth2:
        - settings:write
      parameters:
      - schema:
          type: string
          description: Tenant slug (URL-safe identifier).
          example: dr-martin
        required: true
        description: Tenant slug (URL-safe identifier).
        name: slug
        in: path
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateTenantBody'
      responses:
        '200':
          description: Updated tenant.
          content:
            application/json:
              schema:
                type: object
                properties:
                  tenant:
                    type: object
                    properties:
                      slug:
                        type: string
                      name:
                        type: string
                      botName:
                        type:
                        - string
                        - 'null'
                      botTitle:
                        type:
                        - string
                        - 'null'
                      botLore:
                        type:
                        - string
                        - 'null'
                      botTone:
                        $ref: '#/components/schemas/BotTone'
                      useTutoiement:
                        type: boolean
                      allowEmojis:
                        type: boolean
                      botAvatar:
                        type:
                        - string
                        - 'null'
                      avatarType:
                        type:
                        - string
                        - 'null'
                      avatarBackground:
                        type:
                        - string
                        - 'null'
                      primaryColor:
                        type: string
                      secondaryColor:
                        type:
                        - string
                        - 'null'
                      showAiBadge:
                        type: boolean
                      plan:
                        type: string
                      conversationsLimit:
                        type: integer
                      conversationsUsed:
                        type: integer
                      segmentsLimit:
                        type: integer
                      corpusLimit:
                        type: integer
                      allowedDomains:
                        type: array
                        items:
                          type: string
                      contentPolicy:
                        $ref: '#/components/schemas/ContentPolicy'
                      mcpToolsUrl:
                        type:
                        - string
                        - 'null'
                      mcpToolsMaxTools:
                        type: integer
                required:
                - tenant
      operationId: putTenantsBySlug
      x-operation-id-source: derived
    servers:
    - url: https://api.animam.ai
      description: Production
  /tenants/{slug}/mcp-tools:
    put:
      tags:
      - Tenants
      summary: Configure external MCP server as tool source
      description: Pro+ only. URL must be HTTPS. Tools are discovered via tools/list and proxied via tools/call (cached 5min).
      security:
      - bearerAuth: []
      - oauth2:
        - settings:write
      parameters:
      - schema:
          type: string
          description: Tenant slug (URL-safe identifier).
          example: dr-martin
        required: true
        description: Tenant slug (URL-safe identifier).
        name: slug
        in: path
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateMcpToolsBody'
      responses:
        '200':
          description: Updated MCP tools config.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/McpToolsConfig'
      operationId: putTenantsBySlugMcpTools
      x-operation-id-source: derived
    servers:
    - url: https://api.animam.ai
      description: Production
components:
  schemas:
    BotTone:
      type: string
      enum:
      - FORMAL
      - NEUTRAL
      - FRIENDLY
      - PLAYFUL
      - TECHNICAL
    UpdateTenantBody:
      type: object
      properties:
        botName:
          type: string
          maxLength: 50
        botTitle:
          type: string
          maxLength: 100
        botLore:
          type: string
        botTone:
          $ref: '#/components/schemas/BotTone'
        useTutoiement:
          type: boolean
        allowEmojis:
          type: boolean
        primaryColor:
          type: string
          pattern: ^#[0-9A-Fa-f]{6}$
        secondaryColor:
          type:
          - string
          - 'null'
          pattern: ^#[0-9A-Fa-f]{6}$
        showAiBadge:
          type: boolean
        botAvatar:
          type:
          - string
          - 'null'
          maxLength: 500
          format: uri
        avatarType:
          type: string
          enum:
          - DEFAULT
          - UPLOAD
          - LIBRARY
          - GENERATED
        teaserText:
          type:
          - string
          - 'null'
          maxLength: 160
        autoOpen:
          type: boolean
        autoOpenDelay:
          type: integer
          minimum: 3
          maximum: 120
        bubblePulse:
          type: boolean
        allowedDomains:
          type: array
          items:
            type: string
            maxLength: 255
        contentPolicy:
          $ref: '#/components/schemas/ContentPolicy'
    UpdateMcpToolsBody:
      type: object
      properties:
        mcpToolsUrl:
          type:
          - string
          - 'null'
          maxLength: 500
          format: uri
        mcpToolsApiKey:
          type:
          - string
          - 'null'
          maxLength: 500
        mcpToolsMaxTools:
          type: integer
          minimum: 1
          maximum: 20
    McpToolsConfig:
      type: object
      properties:
        mcpToolsUrl:
          type:
          - string
          - 'null'
        mcpToolsMaxTools:
          type: integer
        hasApiKey:
          type: boolean
        plan:
          type: string
      required:
      - mcpToolsUrl
      - mcpToolsMaxTools
      - hasApiKey
    ContentPolicy:
      type: string
      enum:
      - SFW_STRICT
      - SFW
      - MODERATE
      - UNFILTERED
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key (ak_...) or JWT
      description: 'Static API key (`Authorization: Bearer ak_xxx`) or short-lived JWT issued by /oauth/token.'
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: Alternative header for legacy integrations.
    oauth2:
      type: oauth2
      description: OAuth 2.1 + PKCE for MCP-style agent integrations.
      flows:
        authorizationCode:
          authorizationUrl: https://api.animam.ai/oauth/authorize
          tokenUrl: https://api.animam.ai/oauth/token
          scopes:
            corpus:read: Read knowledge base entries
            corpus:write: Create / update / delete knowledge base entries
            segments:read: Read segments
            segments:write: Create / update segments
            settings:read: Read tenant settings
            settings:write: Update tenant settings
            stats:read: Read analytics and usage data
externalDocs:
  url: https://animam.ai/llms-full.txt
  description: Agent-readable full documentation (Markdown).
x-refined-from:
- animam-ai-openapi.json
- animam-ai-original.json