> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# BotMape

> BotMape provides APIs for creating and managing AI agents, knowledge bases, conversations, messages, and usage analytics.

![BotMape logo](https://mintcdn.com/composio-preview/PudKL42NVsy5O-ND/images/toolkits/botmape.svg?fit=max\&auto=format\&n=PudKL42NVsy5O-ND\&q=85\&s=09c94846fb2ca0160dcc077498f8452a)

* **Category:** ai chatbots
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 8
* **Triggers:** 0
* **Slug:** `BOTMAPE`
* **Version:** 20261101\_00

## Tools

> [accordion] Add Knowledge
>
> **Slug:** `BOTMAPE_ADD_KNOWLEDGE`
>
> Add and automatically embed training content in one AI agent's knowledge base, optionally with source or categorization metadata.
>
> #### Input Parameters
>
> **content** `string` *required*
>
> Non-empty training content to embed, such as FAQs, documentation, or policies.
>
> **metadata** `object`
>
> Optional free-form metadata for the content, such as its category, source, or tags.
>
> **ai\_agent\_id** `integer` *required*
>
> Numeric AI agent ID whose knowledge base should receive the training content.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create AI Agent (No API Delete)
>
> **Slug:** `BOTMAPE_CREATE_AI_AGENT`
>
> Permanently create a BotMape AI agent. BotMape provides no documented delete-agent API, so this toolkit cannot remove it afterward, and creation may permanently consume a plan-limited agent slot. Requires explicit confirmation that a lasting agent is intended.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Permanent AI agent display name (1-100 characters). Creating it may consume a plan-limited slot, and no documented API can delete it.
>
> **description** `string`
>
> Brief statement of the lasting AI agent's purpose.
>
> **primary\_color** `string`
>
> Widget theme color as a six-digit hex value such as #6366f1.
>
> **system\_prompt** `string`
>
> Behavior and personality instructions for the new AI agent.
>
> **welcome\_message** `string`
>
> Initial greeting the new AI agent shows visitors.
>
> **confirm\_permanent\_creation** `boolean` *required*
>
> Must be true to confirm that BotMape provides no documented API to delete the new AI agent and that creation may permanently consume a plan-limited agent slot. This confirmation is not sent to BotMape.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Knowledge Entry
>
> **Slug:** `BOTMAPE_DELETE_KNOWLEDGE_ENTRY`
>
> Permanently delete one knowledge-base entry from an AI agent using both the agent ID and knowledge entry ID.
>
> #### Input Parameters
>
> **ai\_agent\_id** `integer` *required*
>
> Numeric ID of the AI agent that owns the knowledge entry.
>
> **knowledge\_entry\_id** `integer` *required*
>
> ID of the knowledge entry to permanently delete; obtain it with List Knowledge Entries.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get AI Agent
>
> **Slug:** `BOTMAPE_GET_AI_AGENT`
>
> Return the detailed configuration, behavior prompt, appearance, and active state of one AI agent by ID.
>
> #### Input Parameters
>
> **ai\_agent\_id** `integer` *required*
>
> Numeric AI agent ID returned by List AI Agents.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Platform Analytics
>
> **Slug:** `BOTMAPE_GET_PLATFORM_ANALYTICS`
>
> Retrieve aggregate BotMape analytics across the account's AI agents, including message and conversation totals and daily activity. Use these statistics to review platform usage and trends.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List AI Agents
>
> **Slug:** `BOTMAPE_LIST_AI_AGENTS`
>
> Return all AI agents owned by the connected BotMape account, including the IDs needed by single-agent, chat, and knowledge tools.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Knowledge Entries
>
> **Slug:** `BOTMAPE_LIST_KNOWLEDGE_ENTRIES`
>
> Return all knowledge-base entries currently attached to one AI agent, including entry IDs needed for deletion.
>
> #### Input Parameters
>
> **ai\_agent\_id** `integer` *required*
>
> Numeric AI agent ID whose knowledge base should be listed.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Message to AI Agent
>
> **Slug:** `BOTMAPE_SEND_MESSAGE_TO_AI_AGENT`
>
> Immediately send a visitor message to an AI agent, creating a conversation or continuing the supplied conversation, and return the generated reply. This permanently adds chat history.
>
> #### Input Parameters
>
> **message** `string` *required*
>
> Non-empty visitor message to send immediately to the AI agent.
>
> **visitor\_id** `string`
>
> Stable external visitor identifier used to associate this message with a visitor.
>
> **ai\_agent\_id** `integer` *required*
>
> ID of the AI agent that should receive the message; use an ID returned by List AI Agents.
>
> **visitor\_name** `string`
>
> Display name to record for the visitor.
>
> **visitor\_email** `string`
>
> Email address to record for the visitor.
>
> **conversation\_id** `string`
>
> Existing conversation ID to continue; omit to start a new conversation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
