# DocsBot AI

DocsBot AI enables the creation of custom chatbots trained on your documentation, facilitating automated customer support and content generation.

- **Category:** ai chatbots
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 38
- **Triggers:** 0
- **Slug:** `DOCSBOT_AI`
- **Version:** 20260223_00

## Tools

### Capture Conversation Lead

**Slug:** `DOCSBOT_AI_CAPTURE_CONVERSATION_LEAD`

Tool to capture lead information by updating conversation metadata and saving the lead. Works whether or not the conversation has been created yet.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | string | Yes | The unique identifier of the bot. Obtain this from the List Bots action. |
| `conv_id` | string | Yes | The unique identifier for the conversation. This can be any string identifier, even if the conversation hasn't been created yet. |
| `team_id` | string | Yes | The unique identifier of the team that owns the bot. Obtain this from the List Teams action. |
| `metadata` | object | Yes | Dictionary containing lead information such as name, email, phone, company, or any other custom fields you want to capture. All values should be strings. |
| `fullChange` | boolean | No | If true, replaces all metadata. If false (default), merges with existing metadata. |

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

**Slug:** `DOCSBOT_AI_CREATE_BOT`

Tool to create a new bot within a team. Use when you have a valid team ID and want to provision a new bot.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | A descriptive name for the new bot (e.g., 'Customer Support Bot', 'Documentation Helper') |
| `privacy` | string ("public" | "private") | No | Privacy setting for the bot. 'public' allows anyone with the link to use it, 'private' restricts access to authenticated users (requires paid plan). Defaults to 'public'. |
| `team_id` | string | Yes | The unique identifier of the team to create the bot in. Obtain this from the List Teams action. |
| `language` | string | No | The language code for the bot's responses (ISO 639-1 format). Defaults to 'en' (English). |
| `description` | string | No | A brief description of what this bot does or is used for |

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

**Slug:** `DOCSBOT_AI_CREATE_SOURCE`

Tool to create a new source for a bot. Sources can be URLs, files, sitemaps, and other types. Use when you have content to add to a bot's knowledge base. For file-based sources, first upload the file using the Upload File to Cloud Storage action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | Source URL. Required when type is 'url', 'sitemap', 'youtube', or 'rss'. Must be a valid HTTP/HTTPS URL. |
| `faqs` | array | No | Array of question-answer pairs. Required when type is 'qa'. Each item must have both 'question' and 'answer' fields. |
| `file` | string | No | Cloud storage file path obtained from the upload-url endpoint. Required when type is 'urls', 'csv', 'document', or 'wp'. Use the Upload File to Cloud Storage action to obtain this path. |
| `type` | string ("url" | "document" | "sitemap" | "wp" | "urls" | "csv" | "rss" | "qa" | "youtube") | Yes | Type of source to create. Choose based on your content: 'url' for single web pages, 'sitemap' for site crawling, 'document' for uploaded files, 'urls' for bulk URL imports, 'csv' for CSV files, 'wp' for WordPress exports, 'rss' for RSS feeds, 'qa' for Q&A pairs, 'youtube' for YouTube videos. |
| `title` | string | No | Title for the source. Required when type is 'document'. For other types, will be auto-generated from the URL if not provided. |
| `bot_id` | string | Yes | The unique identifier of the bot. Obtain this from the List Bots action. |
| `team_id` | string | Yes | The unique identifier of the team. Obtain this from the List Teams action. |
| `scheduleInterval` | string ("daily" | "weekly" | "monthly" | "none") | No | Schedule interval for automatic source refresh. |

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

**Slug:** `DOCSBOT_AI_CREATE_WEBHOOK`

Tool to create a new webhook subscription for a bot. Use when you want to receive real-time notifications for specific events (lead.created, deep_research.done, conversation.escalated, conversation.rated). The target URL must be publicly accessible and support HTTPS.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `label` | string | No | A descriptive name for the webhook subscription to help identify its purpose |
| `bot_id` | string | Yes | The unique identifier of the bot to create the webhook for. Obtain this from the List Bots action. |
| `events` | array | Yes | List of event types to subscribe to. Available events: lead.created, deep_research.done, conversation.escalated, conversation.rated |
| `source` | string | No | Origin identifier for tracking the source of the webhook (e.g., 'zapier', 'composio', 'custom') |
| `team_id` | string | Yes | The unique identifier of the team. Obtain this from the List Teams action. |
| `targetUrl` | string | Yes | The URL where webhook payloads will be delivered (must be publicly accessible HTTPS endpoint) |
| `expirationDate` | string | No | When the webhook subscription expires in ISO 8601 format (e.g., '2024-12-31T23:59:59Z'). Leave empty for no expiration. |

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

**Slug:** `DOCSBOT_AI_DELETE_BOT`

Tool to delete a specific bot by its ID. Use after confirming the bot ID is correct to permanently remove a bot from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | string | Yes | The unique identifier of the bot to be deleted. Can be obtained from the List Bots action. |
| `team_id` | string | Yes | The unique identifier of the team containing the bot. Can be obtained from the List Teams action. |

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

**Slug:** `DOCSBOT_AI_DELETE_CONVERSATION`

Tool to delete a specific conversation by its ID. Use after confirming the conversation ID is correct to permanently remove a conversation. Requires edit permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | string | Yes | The unique identifier of the bot containing the conversation. Can be obtained from the List Bots action. |
| `team_id` | string | Yes | The unique identifier of the team containing the bot. Can be obtained from the List Teams action. |
| `conversation_id` | string | Yes | The unique identifier of the conversation to delete. |

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

**Slug:** `DOCSBOT_AI_DELETE_LEAD`

Tool to delete a specific lead by ID. Use after confirming the lead ID to permanently remove a lead record from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | string | Yes | The unique identifier of the bot. Can be obtained from the List Bots action. |
| `lead_id` | string | Yes | The unique identifier of the lead to delete. |
| `team_id` | string | Yes | The unique identifier of the team. Can be obtained from the List Teams action. |

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

**Slug:** `DOCSBOT_AI_DELETE_QUESTION`

Tool to delete a specific question from history. Use after confirming the question ID to permanently remove a question log entry from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | string | Yes | The unique identifier of the bot. Can be obtained from the List Bots action. |
| `team_id` | string | Yes | The unique identifier of the team. Can be obtained from the List Teams action. |
| `question_id` | string | Yes | The unique identifier of the question to delete. Can be obtained from the List Questions action. |

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

**Slug:** `DOCSBOT_AI_DELETE_SOURCE`

Tool to delete a specific source from a bot by its ID. Use after confirming the source ID is correct to permanently remove a source from the bot's knowledge base.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | string | Yes | The unique identifier of the bot. Can be obtained from the List Bots action. |
| `team_id` | string | Yes | The unique identifier of the team. Can be obtained from the List Teams action. |
| `source_id` | string | Yes | The unique identifier of the source to delete. Can be obtained from the List Sources action. |

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

**Slug:** `DOCSBOT_AI_DELETE_WEBHOOK`

Tool to delete a webhook (unsubscribe) by its ID. Use after confirming the webhook ID is correct to permanently remove a webhook subscription.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | string | Yes | The unique identifier of the bot. Can be obtained from the List Bots action. |
| `team_id` | string | Yes | The unique identifier of the team. Can be obtained from the List Teams action. |
| `webhook_id` | string | Yes | The unique identifier of the webhook to delete. Can be obtained from the List Webhooks action. |

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

### Generate Conversation Ticket

**Slug:** `DOCSBOT_AI_DOCSBOT_CONVERSATION_TICKET_CREATION`

Generates a structured support ticket from a Chat Agent conversation. Use this tool to convert an existing bot conversation into a formatted helpdesk ticket containing a subject line and message body written from the user's perspective. Prerequisites: - Requires a conversation created via the Chat Agent API (not the legacy Chat API) - Requires Standard plan or higher - The conversation must exist and be accessible with the provided credentials

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | string | Yes | The unique identifier for the bot within the team. Can be obtained from the list_bots action. |
| `team_id` | string | Yes | The unique identifier for the team. Can be obtained from the list_teams action. |
| `conversation_id` | string | Yes | The unique identifier for the conversation to generate a ticket from. Must be from a conversation created via the Chat Agent API. |

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

**Slug:** `DOCSBOT_AI_GET_BOT`

Tool to fetch details of a specific bot by ID within a team. Use after confirming valid team and bot IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | string | Yes | The unique identifier of the bot to retrieve. Obtain this from the List Bots action. |
| `team_id` | string | Yes | The unique identifier of the team that owns the bot. Obtain this from the List Teams action. |

#### 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 Bot Monthly Reports

**Slug:** `DOCSBOT_AI_GET_BOT_REPORTS`

Tool to retrieve monthly statistical reports for a bot. Returns question resolution metrics for a selected month. Use this to analyze bot performance and track question resolution trends over time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `month` | string | No | Month to get report for in YYYY-MM format (e.g., '2024-06'). If not provided, returns the latest available report. |
| `bot_id` | string | Yes | The unique identifier of the bot to get reports for. Obtain this from the List Bots action. |
| `team_id` | string | Yes | The unique identifier of the team that owns the bot. Obtain this from the List Teams action. |

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

**Slug:** `DOCSBOT_AI_GET_BOT_STATS`

Tool to retrieve comprehensive statistics and analytics for a bot over a time period or date range. Returns key metrics (resolution rate, deflection rate, time saved), time series data for questions and ratings, distribution data for feedback and escalations, and agent mode conversation analytics. Use after confirming valid team and bot IDs from List Teams and List Bots actions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | string | Yes | The unique identifier of the bot to retrieve statistics for. Obtain this from the List Bots action. |
| `endDate` | string | No | End of date range in ISO 8601 or YYYY-MM-DD format. Must be provided together with start_date. Cannot be used with time_delta. |
| `team_id` | string | Yes | The unique identifier of the team that owns the bot. Obtain this from the List Teams action. |
| `startDate` | string | No | Start of date range in ISO 8601 or YYYY-MM-DD format. Must be provided together with end_date. Cannot be used with time_delta. |
| `timeDelta` | integer | No | The time period in days to analyze. Common values: 7 (week), 30 (month), 90 (quarter), 365 (year). Cannot be used together with start_date/end_date. Defaults to 30 if no date parameters provided. |

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

**Slug:** `DOCSBOT_AI_GET_SOURCE`

Tool to retrieve detailed information about a specific source by its ID. Use when you need complete metadata about a source including indexed URLs, FAQs, and processing status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | string | Yes | The unique identifier of the bot. Obtain this from the List Bots action. |
| `team_id` | string | Yes | The unique identifier of the team. Obtain this from the List Teams action. |
| `source_id` | string | Yes | The unique identifier of the source to retrieve. Obtain this from the List Sources action. |

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

**Slug:** `DOCSBOT_AI_GET_TEAM`

Tool to fetch details of a specific team by its ID. Use when you need full team info including members and settings after confirming the team ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `team_id` | string | Yes | The unique identifier of the team to retrieve. Obtain valid team IDs using the List Teams action. |

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

**Slug:** `DOCSBOT_AI_GET_UPLOAD_URL`

Get a presigned upload URL for uploading files as sources. Use this before uploading large files to DocsBot. The workflow is: 1) Get upload URL, 2) Upload file to the URL, 3) Create source with the file path.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | string | Yes | The unique identifier of the bot to upload files for. Obtain this from the List Bots action. |
| `team_id` | string | Yes | The unique identifier of the team that owns the bot. Obtain this from the List Teams action. |
| `fileName` | string | Yes | The name of the file to upload (including extension). This will be used as the filename in cloud storage. |

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

**Slug:** `DOCSBOT_AI_GET_WEBHOOK`

Tool to retrieve details of a specific webhook by ID. Use when you need webhook configuration, delivery status, or subscription details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | string | Yes | The unique identifier of the bot that owns the webhook. Obtain this from the List Bots action. |
| `team_id` | string | Yes | The unique identifier of the team that owns the webhook. Obtain this from the List Teams action. |
| `webhook_id` | string | Yes | The unique identifier of the webhook to retrieve. Obtain this from the List Webhooks action. |

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

**Slug:** `DOCSBOT_AI_LIST_BOTS`

List all bots for a given team. Returns detailed information about each bot including configuration, statistics, and status. Use this action to discover available bots before performing operations like getting bot details or listing sources.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `team_id` | string | Yes | The unique identifier of the team to list bots for. Can be obtained from the List Teams action. |

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

**Slug:** `DOCSBOT_AI_LIST_CONVERSATIONS`

Tool to list conversation history for a bot with pagination. Returns a limited subset of conversation properties including titles, timestamps, sentiment, and status. Use this to discover conversations before retrieving full details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number (0-indexed). Defaults to 0. |
| `bot_id` | string | Yes | The unique identifier of the bot. Can be obtained from the List Bots action. |
| `perPage` | integer | No | Results per page. Defaults to 25. |
| `team_id` | string | Yes | The unique identifier of the team. Can be obtained from the List Teams action. |

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

**Slug:** `DOCSBOT_AI_LIST_LEADS`

Tool to list captured leads for a bot with pagination and date filtering. Use after confirming valid team and bot IDs. Example: "List leads for bot abc123 starting from 2024-01-01."

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number (0-indexed). Defaults to 0. |
| `bot_id` | string | Yes | The unique identifier of the bot to list leads for. Obtain this from the List Bots action. |
| `endDate` | string | No | Filter by lead createdAt end time (ISO datetime format, e.g., '2024-12-31T23:59:59Z'). |
| `perPage` | integer | No | Results per page. Defaults to 50. |
| `team_id` | string | Yes | The unique identifier of the team that owns the bot. Obtain this from the List Teams action. |
| `startDate` | string | No | Filter by lead createdAt start time (ISO datetime format, e.g., '2024-01-01T00:00:00Z'). |

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

**Slug:** `DOCSBOT_AI_LIST_QUESTIONS`

Tool to list all questions asked of a specific bot. Use after confirming the bot's identifier. Example: "List questions for bot abc123 with status 'unanswered'."

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of items to return. |
| `bot_id` | string | Yes | The unique identifier of the bot. |
| `offset` | integer | No | Number of items to skip before starting to collect results. |
| `search` | string | No | Search term to filter the questions. |
| `status` | string ("answered" | "unanswered") | No | Filter by question status. |
| `team_id` | string | Yes | The unique identifier of the team. |

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

**Slug:** `DOCSBOT_AI_LIST_RESEARCH_JOBS`

Tool to list all deep research jobs for a bot with pagination support. Use after confirming valid team and bot IDs. Returns details about each research job including status, question, and timestamps.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number (0-indexed). Defaults to 0. |
| `bot_id` | string | Yes | The unique identifier of the bot to list research jobs for. Obtain this from the List Bots action. |
| `perPage` | integer | No | Number of results per page. Defaults to 25. |
| `team_id` | string | Yes | The unique identifier of the team that owns the bot. Obtain this from the List Teams action. |

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

**Slug:** `DOCSBOT_AI_LIST_SOURCES`

Retrieves a paginated list of all sources for a specific bot within a team. Sources are the content (URLs, files, sitemaps, etc.) that have been indexed for the bot's knowledge base. Use this to see what data sources a bot has been trained on.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (0-based index). Defaults to 0 if not specified. |
| `bot_id` | string | Yes | The unique identifier of the bot. Obtain this from the List Bots action. |
| `perPage` | integer | No | Number of sources per page (max 100). Defaults to 100 if not specified. |
| `team_id` | string | Yes | The unique identifier of the team. Obtain this from the List Teams action. |

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

**Slug:** `DOCSBOT_AI_LIST_TEAM_MEMBERS`

Tool to list all members of a team including their roles. Use when you need to see who has access to a team and their permission levels.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `team_id` | string | Yes | The unique identifier of the team whose members to list. Obtain valid team IDs using the List Teams action. |

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

**Slug:** `DOCSBOT_AI_LIST_TEAMS`

Tool to list all teams. Use when you need to retrieve every team associated with the authenticated user.

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

**Slug:** `DOCSBOT_AI_LIST_WEBHOOKS`

List all registered webhooks for a bot. Returns webhook configurations including target URLs, subscribed events, and status. Use this action to discover configured webhooks before creating, updating, or deleting them.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | string | Yes | The unique identifier of the bot to list webhooks for. Obtain this from the List Bots action. |
| `team_id` | string | Yes | The unique identifier of the team that owns the bot. Obtain this from the List Teams action. |

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

### Rate Answer

**Slug:** `DOCSBOT_AI_RATE_ANSWER`

Tool to rate an answer from chat APIs as positive (1), neutral (0), or negative (-1). Use when recording user feedback on bot responses for statistics shown in chat logs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | string | Yes | The unique identifier of the bot. Obtain this from the List Bots action. |
| `rating` | integer | Yes | The rating value for the answer. Must be 1 (positive/helpful), 0 (neutral), or -1 (negative/unhelpful). Used for recording statistics in chat logs. |
| `team_id` | string | Yes | The unique identifier of the team. Obtain this from the List Teams action. |
| `answer_id` | string | Yes | The unique identifier of the answer to rate. Obtained from chat API responses or chat logs. |

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

### Refresh Source

**Slug:** `DOCSBOT_AI_REFRESH_SOURCE`

Tool to refresh a source to re-index its content. Use when a source needs to be updated with the latest content from its origin. Only works with failed sources for retry purposes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | string | Yes | The unique identifier of the bot. Obtain this from the List Bots action. |
| `team_id` | string | Yes | The unique identifier of the team. Obtain this from the List Teams action. |
| `source_id` | string | Yes | The unique identifier of the source to refresh. Obtain this from the List Sources action. |

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

### Semantic Search Bot Content

**Slug:** `DOCSBOT_AI_SEARCH_SEMANTIC`

Tool to perform semantic search on a bot's indexed content. Returns the most relevant source chunks for a query. Use when you need to search the bot's knowledge base without triggering a full conversation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `alpha` | number | No | Balance between keyword and semantic search. An alpha of 1 is pure semantic vector search, an alpha of 0 is pure keyword search. Range: 0-1. Defaults to 0.75. |
| `query` | string | Yes | The search query to find relevant content chunks in the bot's knowledge base. |
| `top_k` | integer | No | Number of most relevant results to return. Defaults to 5. |
| `bot_id` | string | Yes | The unique identifier of the bot to search. Obtain this from the List Bots action. Note: the bot must be ready and have indexed sources. |
| `autocut` | string | No | Automatically cut results to a certain number of groups. Can be a boolean (false to disable) or an integer specifying the number of groups. Defaults to false. |
| `team_id` | string | Yes | The unique identifier of the team that owns the bot. Obtain this from the List Teams action. |
| `use_glossary` | boolean | No | Whether to use the bot's glossary to modify the search query. Defaults to false. |

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

### Test Escalated Webhook

**Slug:** `DOCSBOT_AI_TEST_ESCALATED_WEBHOOK`

Tool to trigger a test delivery of the conversation.escalated webhook. Use to verify webhook configuration is working correctly.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | string | Yes | The unique identifier of the bot to test the webhook for. Obtain this from the List Bots action. |
| `team_id` | string | Yes | The unique identifier of the team that owns the bot. Obtain this from the List Teams action. |

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

### Test Lead Webhook

**Slug:** `DOCSBOT_AI_TEST_LEAD_WEBHOOK`

Tool to trigger a test lead webhook delivery. Use when you need to test webhook integration for lead capture events. Requires owner or admin permissions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | string | Yes | The unique identifier of the bot. Obtain this from the List Bots action. |
| `team_id` | string | Yes | The unique identifier of the team. Obtain this from the List Teams action. |

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

### Test Research Webhook

**Slug:** `DOCSBOT_AI_TEST_RESEARCH_WEBHOOK`

Tool to trigger a deep research webhook delivery test. Use to verify webhook configurations are working correctly.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | string | Yes | The unique identifier of the bot to test research webhooks for. Obtain this from the List Bots action. |
| `team_id` | string | Yes | The unique identifier of the team that owns the bot. Obtain this from the List Teams action. |

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

### Trigger Rated Webhook Test

**Slug:** `DOCSBOT_AI_TRIGGER_RATED_WEBHOOK_TEST`

Tool to trigger a conversation.rated webhook delivery test for a specific bot. Use when you need to test webhook integration for conversation rating events.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | string | Yes | The unique identifier of the bot to test webhook delivery for. Obtain this from the List Bots action. |
| `team_id` | string | Yes | The unique identifier of the team that owns the bot. Obtain this from the List Teams action. |

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

### Update Bot

**Slug:** `DOCSBOT_AI_UPDATE_BOT`

Update a bot's configuration settings such as name, description, model, temperature, and appearance. Only fields provided in the request will be modified; omitted fields remain unchanged. Requires valid team_id and bot_id. Use LIST_BOTS to find available bot IDs first.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New display name for the bot. This is shown in embeds and share links. |
| `color` | string | No | Hex color value for the bot's widget theme (e.g., '#1292EE'). |
| `model` | string | No | OpenAI model for the bot to use (e.g., 'gpt-4o', 'gpt-4o-mini', 'gpt-5-mini'). |
| `bot_id` | string | Yes | ID of the bot to update. Required to identify which bot to modify. |
| `privacy` | string | No | Bot visibility setting. Must be 'public' or 'private'. |
| `team_id` | string | Yes | ID of the team the bot belongs to. Required to identify the bot's parent team. |
| `language` | string | No | Language code for the bot (e.g., 'en', 'es', 'jp'). |
| `description` | string | No | New description for the bot. Shown in embeds and share links. |
| `supportLink` | string | No | URL shown as support link after bot replies. Empty string disables it. |
| `temperature` | number | No | Sampling temperature for model responses, between 0 and 2. Lower values are more deterministic. |
| `customPrompt` | string | No | Custom prompt instructions for the bot's behavior. Only editable on Pro plan and higher. |
| `showCopyButton` | boolean | No | Whether to show copy-to-clipboard button for bot responses. |

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

### Update Team

**Slug:** `DOCSBOT_AI_UPDATE_TEAM`

Tool to update specific fields for a team. Use after confirming the team ID when you need to change the team's name or OpenAI API key. Returns the updated team record.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | The team name. At least one of 'name' or 'openai_key' must be provided. |
| `team_id` | string | Yes | The unique identifier of the team to update |
| `openAIKey` | string | No | The partial OpenAI API key used by the team's bots. At least one of 'name' or 'openai_key' must be provided. |

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

### Update Webhook

**Slug:** `DOCSBOT_AI_UPDATE_WEBHOOK`

Tool to update a webhook's status, target URL, label, or expiration date. Use when you need to modify webhook configuration. Requires valid team_id, bot_id, and webhook_id. Only provided fields will be updated.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `label` | string | No | Label for the webhook to help identify it. |
| `bot_id` | string | Yes | The unique identifier of the bot that owns the webhook. Obtain this from the List Bots action. |
| `events` | array | No | Array of event types to subscribe to (e.g., 'lead.created', 'deep_research.done'). |
| `team_id` | string | Yes | The unique identifier of the team that owns the bot. Obtain this from the List Teams action. |
| `targetUrl` | string | No | The webhook target URL where events will be sent. |
| `webhook_id` | string | Yes | The unique identifier of the webhook to update. |
| `expirationDate` | string | No | ISO 8601 date string for webhook expiration. After this date, the webhook will no longer receive events. |

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

### Upload File to Cloud Storage

**Slug:** `DOCSBOT_AI_UPLOAD_FILE_TO_CLOUD_STORAGE`

Upload a file to cloud storage via a presigned URL. Use this tool after obtaining a presigned upload URL from the DocsBot API (GET /teams/:teamId/bots/:botId/upload-url?fileName=FILENAME). The workflow is: 1. Get presigned URL from DocsBot upload-url endpoint 2. Use this tool to upload the file to the presigned URL 3. Create a source using the 'file' path returned from step 1

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | object | No | Form fields for S3 POST multipart uploads. When provided, triggers multipart POST instead of PUT. Leave empty/null for standard DocsBot uploads which use PUT with Content-Type: application/octet-stream. |
| `headers` | object | No | Additional headers for the upload request. For DocsBot uploads, Content-Type: application/octet-stream is added automatically for PUT uploads if not specified. |
| `file_path` | string | Yes | Absolute path to the local file to be uploaded. The file must exist and be readable. |
| `upload_url` | string | Yes | Presigned URL obtained from the DocsBot upload-url endpoint (GET /teams/:teamId/bots/:botId/upload-url?fileName=FILENAME). This URL contains authentication credentials for uploading to Google Cloud Storage. |

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