---
canonical_url: "https://docs.composio.dev/toolkits/botmape"
markdown_url: "https://docs.composio.dev/toolkits/botmape.md"
product: "platform"
version: null
last_updated: null
---

# BotMape

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

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

## Tools

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `content` | string | Yes | Non-empty training content to embed, such as FAQs, documentation, or policies. |
| `metadata` | object | No | Optional free-form metadata for the content, such as its category, source, or tags. |
| `ai_agent_id` | integer | Yes | Numeric AI agent ID whose knowledge base should receive the training content. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | 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 | No | Brief statement of the lasting AI agent's purpose. |
| `primary_color` | string | No | Widget theme color as a six-digit hex value such as #6366f1. |
| `system_prompt` | string | No | Behavior and personality instructions for the new AI agent. |
| `welcome_message` | string | No | Initial greeting the new AI agent shows visitors. |
| `confirm_permanent_creation` | boolean | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ai_agent_id` | integer | Yes | Numeric ID of the AI agent that owns the knowledge entry. |
| `knowledge_entry_id` | integer | Yes | ID of the knowledge entry to permanently delete; obtain it with List Knowledge Entries. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ai_agent_id` | integer | Yes | Numeric AI agent ID returned by List AI Agents. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Platform Analytics

**Slug:** `BOTMAPE_GET_PLATFORM_ANALYTICS`

Return account-wide BotMape message and conversation totals, daily activity, averages, and per-agent statistics.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ai_agent_id` | integer | Yes | Numeric AI agent ID whose knowledge base should be listed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `message` | string | Yes | Non-empty visitor message to send immediately to the AI agent. |
| `visitor_id` | string | No | Stable external visitor identifier used to associate this message with a visitor. |
| `ai_agent_id` | integer | Yes | ID of the AI agent that should receive the message; use an ID returned by List AI Agents. |
| `visitor_name` | string | No | Display name to record for the visitor. |
| `visitor_email` | string | No | Email address to record for the visitor. |
| `conversation_id` | string | No | Existing conversation ID to continue; omit to start a new conversation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |