# Chat With Chatbot
Source: https://docs.droxy.ai/api-reference/chatbot/chat-with-chatbot

/api-reference/v1.json post /v1/chatbot/chat
Ask anything to your chatbot.



# Chat With Chatbot With Streaming
Source: https://docs.droxy.ai/api-reference/chatbot/chat-with-chatbot-with-streaming

/api-reference/v1.json post /v1/chatbot/chat-stream
Ask anything to your chatbot with response streaming.



# Create Chatbot
Source: https://docs.droxy.ai/api-reference/chatbot/create-chatbot

/api-reference/v1.json post /v1/chatbot
Create a chatbot.



# Delete Chatbot By Id
Source: https://docs.droxy.ai/api-reference/chatbot/delete-chatbot-by-id

/api-reference/v1.json delete /v1/chatbot/{id}
Delete your chatbot by it's id.



# Get All Chatbots
Source: https://docs.droxy.ai/api-reference/chatbot/get-all-chatbots

/api-reference/v1.json get /v1/chatbot/all
Get all your chatbots.



# Get Chatbot By Id
Source: https://docs.droxy.ai/api-reference/chatbot/get-chatbot-by-id

/api-reference/v1.json get /v1/chatbot/{id}
Get your chatbot by it's id.



# Update Chatbot Avatar
Source: https://docs.droxy.ai/api-reference/chatbot/update-chatbot-avatar

/api-reference/v1.json put /v1/chatbot/avatar/{id}
Update a chatbot's avatar.



# Update Chatbot By Id
Source: https://docs.droxy.ai/api-reference/chatbot/update-chatbot-by-id

/api-reference/v1.json put /v1/chatbot/{id}
Update a chatbot by it's id.



# Get Chatbot Conversations
Source: https://docs.droxy.ai/api-reference/conversation/get-chatbot-conversations

/api-reference/v1.json get /v1/conversation/{id}
Get the chatbot conversations.



# Save Chatbot Conversation
Source: https://docs.droxy.ai/api-reference/conversation/save-chatbot-conversation

/api-reference/v1.json post /v1/conversation
Save a chatbot conversation.



# Stream Responses
Source: https://docs.droxy.ai/api-reference/guides/streaming

This guide will show you how to stream responses from the API

[Chat With Chatbot With Streaming](/api-reference/chatbot/chat-with-chatbot-with-streaming) endpoint returns a data stream consisting of events, which can include both partial responses to the user's input and/or other event messages from the server.

The streamed data contains different types of events. Each event carries its own specific type identifier. The client must inspect each event to determine its type and process it accordingly.

To handle streaming responses, you can use the following code snippets:

<Tabs>
  <Tab title="Python">
    ```python theme={null}
    import requests
    import json

    response = requests.post(
        'https://api.droxy.ai/v1/chatbot/chat-stream',
        headers={
            'accept': 'application/json',
            'content-type': 'application/json',
            'x-api-key': '<API_KEY>'
        },
        data=json.dumps({
            'chatbotId': '<CHATBOT_ID>',
            'conversation': [{'fromUser': True, 'text': 'Hello!'}]
        }),
        stream=True
    )

    # Raise an error if the response status isn't successful.
    if response.status_code != 201:
        error = response.json()
        raise Exception(error.get('message', 'Request failed'))
    else:
        try:
            # Process each chunk event in the response stream. Due to buffering, more than one chunk may be available at a time.
            for chunk in response.iter_lines():
                if chunk:
                    # Decode the line
                    decoded_event = chunk.decode('utf-8')

                    # Load the line as JSON and process the message
                    event = json.loads(decoded_event)

                    # Get the event type
                    event_type = event.get("type")

                    # Handle the partial response here.
                    if event_type == 'partialResponse':
                        print('Partial response:', event)

                    # Handle the end of the stream here.
                    elif event_type == 'streamEnd':
                        print('Stream ended:', event)
                        break
                    
                    # Handle any errors while streaming here.
                    elif event_type == 'error':
                        raise Exception(f"Error from stream: {event.get('message')}")

        except Exception as e:
            print(f'Error processing stream: {e}')
    ```
  </Tab>

  <Tab title="JavaScript">
    ```javascript theme={null}
    const response = await fetch('https://api.droxy.ai/v1/chatbot/chat-stream', {
      method: 'POST',
      headers: {
        accept: 'application/json',
        'content-type': 'application/json',
        'x-api-key': '<API_KEY>'
      },
      body: JSON.stringify({
        chatbotId: '<CHATBOT_ID>',
        conversation: [{fromUser: true, text: 'Hello!'}]
      })
    });

    // Throw an error if the response status isn't successful.
    if (!response.ok) {
      const error = await response.json();
      throw Error(error.message);
    }

    // Ensure there is a response body to read from.
    if (!response.body) {
      throw Error('No response body');
    }

    const reader = response.body.getReader();
    const decoder = new TextDecoder();

    try {
      while (true) {
        const { value, done } = await reader.read();
        if (done) break; // Stop reading if the stream is finished.

        // Decode the stream's chunks to an array of strings. Due to buffering, more than one chunk may be available at a time.
        const chunkValues = decoder.decode(value, { stream: true }).split('\n').filter(Boolean);

        for(const chunkValue of chunkValues){
          // Parse the event chunk into JSON.
          const json = JSON.parse(chunkValue);

          // Process the event based on its type.
          switch (json.type) {
            case 'partialResponse':
              // Handle the partial response here.
              console.log('Partial response:', json);
              break;
              
            case 'streamEnd':
              // Handle the end of the stream here.
              console.log('Stream ended:', json);
              break;

            case 'error':
              // Handle any errors while streaming here.
              throw new Error(json.message);
          }
        }
      }
    } catch (error) {
      console.error(`Stream reading failed: ${error}`);
    }
    ```
  </Tab>
</Tabs>


# Introduction
Source: https://docs.droxy.ai/api-reference/introduction

Explore Droxy API with our guides and API reference

<Note>
  Droxy API is accessible for users with an Advanced tier subscription or higher. For detailed pricing information and to find the tier that's right for you, please visit our [pricing page](https://www.droxy.ai/pricing).
</Note>

## Create an API key

In order to authenticate your requests, you will need to create an API key first. You can do so by following the steps below:

1. Navigate to the [Dashboard](https://app.droxy.ai) and click on the `API` tab.
2. Click on the `+ Add` button to create a new API key.

<Frame>
  <img alt="Create API key" />
</Frame>

3. A new key will be generated for you. Make sure to **copy it as it won't be fully visible once you close the modal**.


# Get Chatbot Leads
Source: https://docs.droxy.ai/api-reference/lead/get-chatbot-leads

/api-reference/v1.json get /v1/lead/{id}
Get the leads generated from the chatbot.



# Chat With Resource
Source: https://docs.droxy.ai/api-reference/resource/chat-with-resource

/api-reference/v1.json post /v1/resource/chat
Ask anything to your resource.



# Chat With Resource With Streaming
Source: https://docs.droxy.ai/api-reference/resource/chat-with-resource-with-streaming

/api-reference/v1.json post /v1/resource/chat-stream
Ask anything to your resource with response streaming.



# Create File Resource
Source: https://docs.droxy.ai/api-reference/resource/create-file-resource

/api-reference/v1.json post /v1/resource/file
Create a file resource by upload a PDF or MP4 file.



# Create Raw Text Resource
Source: https://docs.droxy.ai/api-reference/resource/create-raw-text-resource

/api-reference/v1.json post /v1/resource/text
Create a resource with raw text.



# Create Website Resource
Source: https://docs.droxy.ai/api-reference/resource/create-website-resource

/api-reference/v1.json post /v1/resource/website
Create a Website resource.



# Create YouTube Resource
Source: https://docs.droxy.ai/api-reference/resource/create-youtube-resource

/api-reference/v1.json post /v1/resource/youtube
Create a YouTube resource.



# Delete Resource By Id
Source: https://docs.droxy.ai/api-reference/resource/delete-resource-by-id

/api-reference/v1.json delete /v1/resource/{id}
Delete your resource by it's id.



# Get All Resources
Source: https://docs.droxy.ai/api-reference/resource/get-all-resources

/api-reference/v1.json get /v1/resource/all
Get all your resources.



# Get Resource By Id
Source: https://docs.droxy.ai/api-reference/resource/get-resource-by-id

/api-reference/v1.json get /v1/resource/{id}
Get your resource by it's id.



# Product Updates
Source: https://docs.droxy.ai/changelog/product-updates

Latest features and improvements to Droxy

<Update label="2023-11-30" description="Appointments via Phone Agents">
  # Phone Agents + Appointments

  We're excited to announce our integration with **Cal.com**, enabling AI-powered realtime appointment scheduling through your phone agents.

  <Frame>
    <img alt="Cal.com Integration" />
  </Frame>

  ### Key Features

  * Connect your Cal.com account to automate appointment scheduling through phone agents
  * Real-time calendar availability checking
  * Automatic timezone handling and conflict prevention
  * Direct integration with popular calendar services (Google, Apple, Outlook)
  * Automated confirmation emails to attendees

  <Frame>
    <img alt="Phone Appointment Scheduling Tool" />
  </Frame>

  ### How can you use this in your business?

  If you spend a lot of time scheduling appointments and figuring out availabilities for your business, you can now hand that off to your Phone Agent that has access to your calendar. The agent can determine availabilities in real-time, book appointments, and send confirmation emails automatically. It's a win-win for your business and customers - they don't have to wait in line and can book appointments outside of business hours, while you can spend more time serving your customers.

  ### How can I get started?

  Enable appointment scheduling for your phone agents by following our step-by-step guides:

  * [Set up Cal.com integration](/documentation/integrations/caldotcom)
  * [Enable appointment scheduling for your phone agents](/documentation/agents/phone/appointments)
</Update>


# Basic Agent
Source: https://docs.droxy.ai/documentation/agents/basic

Learn how to create a basic agent that you can personaly use and share with others via a link.

<img alt="Basic Agent" />

## What is a Basic Agent?

It is an LLM-based agent that you can use for Q/A and/or share with others via a link. The agent:

* Learns from your knowledge sources including website content, PDFs, Google Drive documents, YouTube videos, and other documents
* Provides real-time responses to queries based on your specific information
* Answers following your configured behavior and tone

## Setting Up Your Basic Agent

In the Droxy dashboard, go to the **Agents** section and click on **+Add**. Then select **Basic Agent**.

<Frame>
  <img alt="Basic Agent" />
</Frame>

### 1. Knowledge Configuration

Before your agent can answer questions, you'll need to ground it with knowledge. This will help it understand your specific information and answer questions more accurately.

<Frame>
  <img alt="Knowledge Configuration" />
</Frame>

1. Upload relevant documents (PDFs, text files, Google Drive documents, etc.)
2. Add website URLs for the agent to learn from
3. Link YouTube videos that contain relevant informations or tutorials
4. Import custom knowledge bases or FAQs

### 2. Agent Configuration

Configure your agent's behavior and capabilities:

<Frame>
  <img alt="Agent Configuration" />
</Frame>

Key configuration options include:

* **Behavior**: Define the agent's role, personality, and communication style. Be specific about how the agent should interact. Use the built-in prompt generator to create and refine your agent's instructions.
* **Model**: Select the LLM powering your agent (e.g., GPT-4o mini, Claude Sonnet 4.6, Gemini 3 Flash). Each model consumes different amounts of tokens and has different capabilities.
* **Knowledge Restrictions**: Choose whether to restrict the agent's responses to only your provided knowledge content. Make sure to specify to the agent what to answer if the knowledge base doesn't contain an answer.
* **Emoji Support**: Enable or disable emoji in the agent's responses.

### 3. Customization

Personalize your agent's appearance to your liking:

<Frame>
  <img alt="Customization Options" />
</Frame>

* **Agent Name**: Give your agent a name that reflects its role and purpose
* **Welcome Message**: Set an optional greeting message that appears in a chat bubble when visitors first use the agent
* **Theme Selection**: Choose from pre-built color themes or create your own custom theme
* **Appearance**: Fully customize the look and feel of your agent including colors, backgrounds, and styling to match your brand identity

All colors can be specified using hex codes for precise color matching. The live preview window shows how your customization choices will appear.

## Share Your Agent

Now that your agent is created and configured, you can share it with others via a link.

To share your agent:

<Frame>
  <img alt="Share Menu" />
</Frame>

1. Click the `...` menu on your agent's card
2. Select **Copy share link**
3. Send the link to others to allow them to use your agent.

## View Conversation History

To view the conversation history of your agent:

1. Click the `...` menu on your agent's card
2. Select **Conversations**

<Frame>
  <img alt="Conversation Click" />
</Frame>

This will redirect you to the **Conversations** page where you can view all the conversations that have been had with your agent.

<Frame>
  <img alt="Conversation Page" />
</Frame>


# Facebook Agent
Source: https://docs.droxy.ai/documentation/agents/commenting/facebook

Learn how to create an agent that you can connect to your Facebook page to reply to your customers comments.

<Card title="Coming Soon" icon="sparkles" />

<img alt="Facebook Agent" />


# Instagram Agent
Source: https://docs.droxy.ai/documentation/agents/commenting/instagram

Learn how to create an agent that you can connect to your Instagram profile to reply to your customers comments.

<Card title="Coming Soon" icon="sparkles" />

<img alt="Instagram Agent" />


# Discord Agent
Source: https://docs.droxy.ai/documentation/agents/messaging/discord

Learn how to create an agent that you can connect to your Discord server to respond to your community.

<img alt="Discord Agent" />

## What is a Discord Messaging Agent?

It is an LLM-based agent that you can connect to your Discord server to provide instant support and answers to your community. The agent:

* Learns from your company's knowledge sources including website content, PDFs, YouTube videos, and other documents
* Provides real-time responses to community queries based on your specific business information
* Integrates seamlessly with your Discord server
* Answers in your brand's voice in a natural and conversational manner through Discord chats
* Handles multiple community conversations simultaneously
* Available 24/7 to respond to community inquiries via Discord

## Setting up your Discord Messaging Agent

In the Droxy dashboard, go to the **Agents** section and click on **+ Add**. Then select **Discord Agent** in the **Messaging** category.

<Frame>
  <img alt="Select Discord Agent" />
</Frame>

### 1. Basics

Configure the basics for your Discord agent:

<Frame>
  <img alt="Basics" />
</Frame>

* **Name and Avatar**: Give your agent a name and upload an avatar image that will be displayed in your dashboard
* **Server Invitation Link**: Enter the invitation link for your Discord server and authorize Droxy to join the server
* **Invocation Command**: Enter the command that will be used to invoke your agent in Discord

### 2. Configuration

Configure your agent's behavior to suit your business needs:

<Frame>
  <img alt="Configuration" />
</Frame>

* **Behavior**: Define the agent's role, personality, and communication style. Be specific about how the agent should interact with your community. Use the built-in prompt generator to create and refine your agent's instructions.
* **Model**: Select the LLM powering your agent (e.g., GPT-4o mini, Claude Sonnet 4.6, Gemini 3 Flash). Each model consumes different amounts of tokens and has different capabilities.
* **Knowledge Restrictions**: Choose whether to restrict the agent's responses to only your provided knowledge content. Make sure to specify to the agent what to answer if the knowledge base doesn't contain an answer.
* **Emojis**: Choose whether to enable emojis in the agent's responses

### 3. Knowledge Base

Ground your agent with relevant business information to help it answer community questions accurately:

<Frame>
  <img alt="Knowledge" />
</Frame>

* Upload relevant community documents (PDFs, text files, Google Docs, etc.)
* Add website URLs for the agent to learn from
* Link YouTube videos that contain product information or tutorials
* Import custom knowledge bases or FAQs


# Facebook Agent
Source: https://docs.droxy.ai/documentation/agents/messaging/facebook

Learn how to create an agent that you can connect to your Facebook page to respond to your customers.

<img alt="Facebook Agent" />

## What is a Facebook Messaging Agent?

It is an LLM-based agent that you can connect to your Facebook page to provide instant support and answers to your customers. The agent:

* Learns from your company's knowledge sources including website content, PDFs, YouTube videos, and other documents
* Provides real-time responses to customer queries based on your specific business information
* Integrates seamlessly with your Facebook Page
* Answers in your brand's voice in a natural and conversational manner through Facebook Messenger chats
* Handles multiple customer conversations simultaneously
* Available 24/7 to respond to customer inquiries via Facebook Messenger

## Connect a Facebook Page

In the Droxy dashboard, go to the **Integrations** section and click on the **Facebook** card.

<Frame>
  <img alt="Select Facebook" />
</Frame>

### 1. Start the connection process

Click on the **Synchronize** button to connect a Facebook Page.

<Frame>
  <img alt="Synchronize Facebook Page" />
</Frame>

### 2. Choose a Business Portfolio

Login into your Facebook account and choose a Business Portfolio.

<Frame>
  <img alt="Select Business Portfolio" />
</Frame>

### 3. Choose a Facebook Page

Select the Facebook Page you want to connect.

<Warning>
  Make sure to not unselect previously selected pages.
</Warning>

<Frame>
  <img alt="Select Facebook Page" />
</Frame>

### 4. Confirm the connection

Click on **Save** to accept sharing your Facebook Page with Droxy.

<Frame>
  <img alt="Confirm Connection" />
</Frame>

Click on **Got it** to complete the connection process.

<Frame>
  <img alt="Got it" />
</Frame>

## Setting up your Facebook Messaging Agent

In the Droxy dashboard, go to the **Agents** section and click on **+ Add**. Then select **Facebook Agent** in the **Messaging** category.

<Frame>
  <img alt="Select Facebook Agent" />
</Frame>

### 1. Basics

Configure the basics for your Facebook agent:

<Frame>
  <img alt="Basics" />
</Frame>

* **Name and Avatar**: Give your agent a name and upload an avatar image that will be displayed in your dashboard
* **Connected Account**: Choose a Facebook Page to connect to your agent

### 2. Configuration

Configure your agent's behavior to suit your business needs:

<Frame>
  <img alt="Configuration" />
</Frame>

* **Behavior**: Define the agent's role, personality, and communication style. Be specific about how the agent should interact with visitors. Use the built-in prompt generator to create and refine your agent's instructions.
* **Model**: Select the LLM powering your agent (e.g., GPT-4o mini, Claude Sonnet 4.6, Gemini 3 Flash). Each model consumes different amounts of tokens and has different capabilities.
* **Knowledge Restrictions**: Choose whether to restrict the agent's responses to only your provided knowledge content. Make sure to specify to the agent what to answer if the knowledge base doesn't contain an answer.
* **Emojis**: Choose whether to enable emojis in the agent's responses

### 3. Knowledge Base

Ground your agent with relevant business information to help it answer customer questions accurately:

<Frame>
  <img alt="Knowledge" />
</Frame>

* Upload relevant company documents (PDFs, text files, Google Docs, etc.)
* Add website URLs for the agent to learn from
* Link YouTube videos that contain product information or tutorials
* Import custom knowledge bases or FAQs

### 4. Tools

You can enable the following tools to enhance messaging agent functionality:

<Frame>
  <img alt="Available Tools" />
</Frame>

* **Takeover Request**: Enables the agent to automatically request a conversation to be taken over by a human agent when appropriate or when the user requests to speak to a human. You will receive a notification about the takeover request.

Each tool can be toggled on/off using the switches, allowing you to customize the feature set based on your needs.

## Pausing your Facebook Agent

You can pause your Facebook agent at any time to take over and respond to messages manually. This will stop the agent from responding to new messages.

To pause your agent:

<Frame>
  <img alt="Pause Facebook Agent" />
</Frame>

1. Click the `...` menu on your agent's card
2. Select **Pause**

You can also resume your agent by clicking the `...` menu on your agent's card and selecting **Resume**.


# Instagram Agent
Source: https://docs.droxy.ai/documentation/agents/messaging/instagram

Learn how to create an agent that you can connect to your Instagram profile to respond to your customers.

<img alt="Instagram Agent" />

## What is an Instagram Messaging Agent?

It is an LLM-based agent that you can connect to your Instagram profile to provide instant support and answers to your customers. The agent:

* Learns from your company's knowledge sources including website content, PDFs, YouTube videos, and other documents
* Provides real-time responses to customer queries based on your specific business information
* Integrates seamlessly with your Instagram account
* Answers in your brand's voice in a natural and conversational manner through Instagram chats
* Handles multiple customer conversations simultaneously
* Available 24/7 to respond to customer inquiries via Instagram chats

## Connect an Instagram Account

In the Droxy dashboard, go to the **Integrations** section and click on the **Instagram** card.

<Frame>
  <img alt="Select Instagram" />
</Frame>

### 1. Start the connection process

Click on the **Connect** button to connect an Instagram account.

<Note>
  Only Instagram business accounts are can be connected. If you have a regular Instagram account, you will be asked to switch to a business account during the connection process.
</Note>

<Frame>
  <img alt="Connect Instagram Account" />
</Frame>

### 2. Login with your Instagram account

Login with your Instagram account.

<Frame>
  <img alt="Login with Instagram" />
</Frame>

### 3. Confirm the connection

Click on **Allow** to accept sharing your Instagram account with Droxy.

<Frame>
  <img alt="Confirm Connection" />
</Frame>

## Setting up your Instagram Messaging Agent

In the Droxy dashboard, go to the **Agents** section and click on **+ Add**. Then select **Instagram Agent** in the **Messaging** category.

<Frame>
  <img alt="Select Instagram Agent" />
</Frame>

### 1. Basics

Configure the basics for your Instagram agent:

<Frame>
  <img alt="Basics" />
</Frame>

* **Name and Avatar**: Give your agent a name and upload an avatar image that will be displayed in your dashboard
* **Connected Account**: Choose an Instagram account to connect to your agent

### 2. Configuration

Configure your agent's behavior to suit your business needs:

<Frame>
  <img alt="Configuration" />
</Frame>

* **Behavior**: Define the agent's role, personality, and communication style. Be specific about how the agent should interact with visitors. Use the built-in prompt generator to create and refine your agent's instructions.
* **Model**: Select the LLM powering your agent (e.g., GPT-4o mini, Claude Sonnet 4.6, Gemini 3 Flash). Each model consumes different amounts of tokens and has different capabilities.
* **Knowledge Restrictions**: Choose whether to restrict the agent's responses to only your provided knowledge content. Make sure to specify to the agent what to answer if the knowledge base doesn't contain an answer.
* **Emojis**: Choose whether to enable emojis in the agent's responses

### 3. Knowledge Base

Ground your agent with relevant business information to help it answer customer questions accurately:

<Frame>
  <img alt="Knowledge" />
</Frame>

* Upload relevant company documents (PDFs, text files, Google Docs, etc.)
* Add website URLs for the agent to learn from
* Link YouTube videos that contain product information or tutorials
* Import custom knowledge bases or FAQs

### 4. Tools

You can enable the following tools to enhance messaging agent functionality:

<Frame>
  <img alt="Available Tools" />
</Frame>

* **Takeover Request**: Enables the agent to automatically request a conversation to be taken over by a human agent when appropriate or when the user requests to speak to a human. You will receive a notification about the takeover request.

Each tool can be toggled on/off using the switches, allowing you to customize the feature set based on your needs.

## Pausing your Instagram Agent

You can pause your Instagram agent at any time to take over and respond to messages manually. This will stop the agent from responding to new messages.

To pause your agent:

<Frame>
  <img alt="Pause Instagram Agent" />
</Frame>

1. Click the `...` menu on your agent's card
2. Select **Pause**

You can also resume your agent by clicking the `...` menu on your agent's card and selecting **Resume**.


# WhatsApp Agent
Source: https://docs.droxy.ai/documentation/agents/messaging/whatsapp

Learn how to create an agent that you can connect to your WhatsApp number to respond to your customers.

<img alt="WhatsApp Agent" />

## What is a WhatsApp Messaging Agent?

It is an LLM-based agent that you can connect to your WhatsApp business account to provide instant support and answers to your customers. The agent:

* Learns from your company's knowledge sources including website content, PDFs, YouTube videos, and other documents
* Provides real-time responses to customer queries based on your specific business information
* Integrates seamlessly with your WhatsApp Business Account
* Answers in your brand's voice in a natural and conversational manner through WhatsApp chats
* Handles multiple customer conversations simultaneously
* Available 24/7 to respond to customer inquiries via WhatsApp

## Connect A WhatsApp Business Account

In the Droxy dashboard, go to the **Integrations** section and click on the **WhatsApp** card.

<Frame>
  <img alt="WhatsApp Agent" />
</Frame>

### 1. Start the connection process

Click on the **Connect** button to connect a WhatsApp Business Account.

<Frame>
  <img alt="Connect WhatsApp Account" />
</Frame>

<Note>
  The WhatsApp phone number integrated with the agent can only be used by the agent. It cannot be used on WhatsApp or WhatsApp Business. If you are already using this phone number with WhatsApp, you must delete your account first to free up the number.

  Steps to delete WhatsApp account:

  1. Open the WhatsApp or WhatsApp Business app.
  2. Navigate to Settings > Account > Delete my account.
  3. Confirm the deletion by entering the phone number.
  4. Select 'Delete my account'. After a few minutes, your number will be available again.
</Note>

### 2. Login with your Facebook account

<Frame>
  <img alt="Login with Facebook" />
</Frame>

Click on **Get Started** to continue.

<Frame>
  <img alt="Start" />
</Frame>

### 3. Choose or create a business profile

<Frame>
  <img alt="Portfolio" />
</Frame>

### 4. Choose or create a WhatsApp Business Account

<Frame>
  <img alt="WhatsApp Account" />
</Frame>

### 5. WhatsApp Business Profile (Optional)

If you chose to create a new business account, fill in the required information for your WhatsApp Business Profile.

<Warning>
  Please make sure to follow Meta's [display name guidelines](https://www.facebook.com/business/help/757569725593362) as this could affect your account's eligibility to send messages.
</Warning>

<Frame>
  <img alt="Business Profile" />
</Frame>

### 6. WhatsApp Business Phone Number (Optional)

If you do not have a phone number in your WhatsApp Business Account, add a phone number and verify it.

<Frame>
  <img alt="Phone Number" />
</Frame>

### 7. Confirm the connection

Click on **Continue** to allow Droxy to access your WhatsApp Business Account.

<Frame>
  <img alt="Continue" />
</Frame>

Click on **Finish** to complete the connection process.

<Frame>
  <img alt="Finish" />
</Frame>

## Setting up your WhatsApp Messaging Agent

In the Droxy dashboard, go to the **Agents** section and click on **+ Add**. Then select **WhatsApp Agent** in the **Messaging** category.

<Frame>
  <img alt="Select WhatsApp Agent" />
</Frame>

### 1. Basics

Configure the basics for your WhatsApp agent:

<Frame>
  <img alt="Basics" />
</Frame>

* **Name and Avatar**: Give your agent a name and upload an avatar image that will be displayed in your dashboard
* **Connected Account**: Choose a WhatsApp Business Account to connect to your agent
* **Phone Number**: Choose a WhatsApp phone number to connect to your agent

### 2. Configuration

Configure your agent's behavior to suit your business needs:

<Frame>
  <img alt="Configuration" />
</Frame>

* **Behavior**: Define the agent's role, personality, and communication style. Be specific about how the agent should interact with visitors. Use the built-in prompt generator to create and refine your agent's instructions.
* **Model**: Select the LLM powering your agent (e.g., GPT-4o mini, Claude Sonnet 4.6, Gemini 3 Flash). Each model consumes different amounts of tokens and has different capabilities.
* **Knowledge Restrictions**: Choose whether to restrict the agent's responses to only your provided knowledge content. Make sure to specify to the agent what to answer if the knowledge base doesn't contain an answer.
* **Emojis**: Choose whether to enable emojis in the agent's responses

### 3. Knowledge Base

Ground your agent with relevant business information to help it answer customer questions accurately:

<Frame>
  <img alt="Knowledge" />
</Frame>

* Upload relevant company documents (PDFs, text files, Google Docs, etc.)
* Add website URLs for the agent to learn from
* Link YouTube videos that contain product information or tutorials
* Import custom knowledge bases or FAQs

### 4. Tools

You can enable the following tools to enhance messaging agent functionality:

<Frame>
  <img alt="Available Tools" />
</Frame>

* **Takeover Request**: Enables the agent to automatically request a conversation to be taken over by a human agent when appropriate or when the user requests to speak to a human. You will receive a notification about the takeover request.

Each tool can be toggled on/off using the switches, allowing you to customize the feature set based on your needs.


# Appointment Scheduling
Source: https://docs.droxy.ai/documentation/agents/phone/appointments

Learn how to use the Appointment Scheduling tool with your Phone Agent.

## Tool Overview

The Appointment Scheduling tool enables your Phone Agent to automatically book appointments with callers in a natural, conversational way. The agent:

* Checks real-time availability in your connected calendar
* Handles time zone conversions automatically
* Collects necessary customer information
* Sends confirmation emails with appointment details
* Books directly into your calendar system (Google Calendar, Apple Calendar, etc.) via Cal.com

When a caller requests an appointment, your agent engages in a natural conversation to find a suitable time slot, collects their information, and handles the booking process end-to-end.

## Use Cases

The Appointment Scheduling tool can transform how various businesses handle bookings:

* **Medical Practices**: Enable patients to book appointments 24/7, reducing missed calls and improving accessibility
* **Real Estate**: Automate property viewing scheduling, letting potential buyers book at their convenience
* **Legal Services**: Conduct pre-qualifying conversations and schedule consultations seamlessly
* **Service Businesses**: From salon appointments to consultations, automate booking for any service type

This creates a win-win situation: customers gain 24/7 booking capability while businesses capture more opportunities and reduce administrative overhead.

## Prerequisites

Before setting up appointment scheduling, you'll need:

### 1. Cal.com Account Setup

Create and connect your Cal.com account to Droxy (see our [Cal.com Integration Guide](/documentation/integrations/caldotcom)).

### 2. Create Event Type

In your Cal.com account, create an **Event Type** for your appointments:

<Frame>
  <img alt="Create New Event Type" />
</Frame>

1. Navigate to the **Event Types** tab
2. Click **+ New** to create a new event type
3. Configure the basic settings:
   * Set a clear, descriptive title (the agent will use this in conversations)
   * Specify the appointment duration
   * Click **Continue**

<Frame>
  <img alt="Event Type Configuration" />
</Frame>

### 3. Configure Availability Settings

Set up your availability to ensure accurate booking:

<Frame>
  <img alt="Availability Settings" />
</Frame>

* Set your business hours and availability windows
* Configure the correct time zone for your **Default** availability (this will be used for all appointments associated with this Cal.com account)

### 4. Set Meeting Location

Configure where appointments will take place:

<Frame>
  <img alt="Location Settings" />
</Frame>

Choose from several location types:

* **In Person (Organizer Address)**: For appointments at your business location
* **Phone Call**: For telephone consultations
* **Video Conference**: For virtual meetings via Zoom, Google Meet, etc.

The selected location will be included in the appointment confirmation emails sent to customers.

## Setting Up the Tool

Now that you have your Cal.com account properly configured with event types and availability settings, you can add appointment scheduling to your Phone Agent:

### 1. In the Tools section, click **+ Add tool**

<Frame>
  <img alt="Tools" />
</Frame>

### 2. Select **Appointment Scheduling (Cal.com)**

<Frame>
  <img alt="Select Tool" />
</Frame>

### 3. Configure Tool Settings

<Frame>
  <img alt="Tool Configuration" />
</Frame>

<Note>
  The time zone shown is based on your Cal.com account's default availability settings. When callers request appointments (e.g. "3 PM"), the agent will check availability in this time zone. For example, if your default availability is set to Pacific Time, when a caller asks for "3 PM", the agent will check availability for 3 PM Pacific Time.
</Note>

* **Cal.com Account**: Select your connected account
* **Time Zone**: Verify the displayed time zone
* **Event Type**: Choose the event type created in prerequisites

## Testing Your Setup

After configuration, test the appointment scheduling:

1. Click **Talk with Agent** or call the phone number associated with your agent
2. Say to the agent that you would like to book an appointment
3. Observe how the agent:
   * Checks available slots
   * Suggests times based on your availability
   * Collects and confirms contact information
   * Books the appointment and triggers confirmation emails

Successful bookings will appear in:

* Your Cal.com dashboard
* Connected calendar systems
* Customer's email inbox with confirmation details

## Best Practices

To ensure optimal appointment scheduling:

* Use clear, specific event type names
* Keep your availability calendar up-to-date
* Test the booking flow regularly
* Monitor appointment confirmations


# Overview
Source: https://docs.droxy.ai/documentation/agents/phone/overview

Learn how to create an agent that you can connect to your phone number.

<img alt="Phone Agent" />

## What is a Phone Agent?

It is a real-time voice AI agent that you can connect to your business phone number to handle customer calls automatically. The agent:

* Uses OpenAI's voice-to-voice LLM to conduct natural conversations
* Answers calls on your behalf when you're unavailable or during peak times
* Communicates in multiple languages with human-like voice quality
* Adapts its tone and personality based on your configured preferences
* Learns from your business knowledge to provide accurate responses

## Testing Your Agent During Setup

Before creating your agent, note that you can use the **Talk with agent** button at any time to test your configuration. This allows you to verify how your agent behaves with different settings - for example, after modifying the prompt or adding knowledge, you can immediately test the changes without creating the agent.

<Frame>
  <img alt="Talk with Agent" />
</Frame>

## Setting Up Your Phone Agent

In the Droxy dashboard, go to the **Agents** section and click on **+Add**. Then select **Phone**.

<Frame>
  <img alt="Website Agent" />
</Frame>

### 1. Basics

Configure the fundamental settings for your phone agent:

<Frame>
  <img alt="Basics" />
</Frame>

* **Name and Avatar**: Give your agent a name and upload an avatar image that will be displayed in your dashboard
* **First Message**: Set up the first message the agent will say when answering calls. This is useful if you want to greet the caller with a custom message
* **Voice**: Choose from our selection of natural-sounding voices

### 2. Configuration

Configure your agent's behavior to suit your business needs:

<Frame>
  <img alt="Configuration" />
</Frame>

* **Behavior**: Use our prompt generator for optimized phone agent prompts, or manually craft your custom prompt
* **Model**: Select the real-time voice model that will power your agent
* **Restrictions**: Choose whether to restrict responses to knowledge content. If enabled, you have to specify a fallback message that will be used when information isn't found in its knowledge base

### 3. Tools

In order give your phone agent the ability to perform actions, you can add tools.

<Frame>
  <img alt="Tools" />
</Frame>

For example, you can:

* Add the **Appointment Scheduling** tool to let your agent schedule appointments into your calendar. Learn more [here](/documentation/agents/phone/appointments).
* Enable the **Call Transfer** tool to intelligently route calls based on context. You can configure multiple transfer rules like:
  * Transfer to sales team (+1-555-0123) for **pricing and product inquiries**
  * Transfer to support (+1-555-0456) for **technical issues**

The agent will automatically evaluate the conversation and transfer to the appropriate department.
If needed it will ask the caller clarifying questions to ensure the call is transferred to the right person.

### 4. Connect your Phone Number

Connect your agent to a phone line to allow your customers to easily reach you.

<Frame>
  <img alt="Attach Phone Number" />
</Frame>

There are two options to connect your phone number:

**Get New Number:**

* Paid accounts receive one free phone number (US/Canada only)
* Browse available numbers by region/state
* Select from our list of free numbers and add it to your account

**Import Existing Twilio Number:**

* Enter your Twilio phone number (any country)
* Provide your Account SID
* Add your Auth Token

For phone numbers outside US/Canada, you'll need to import them via Twilio due to additional jurisdiction verification requirements. Don't worry - it's a straightforward process! Check our [Phone Number Integration Guide](/documentation/integrations/phone-numbers) for detailed instructions.

### 5. Knowledge Base

Ground your agent with relevant business information to help it answer customer questions accurately:

<Frame>
  <img alt="Knowledge" />
</Frame>

* Upload relevant company documents (PDFs, text files, Google Docs, etc.)
* Add website URLs for the agent to learn from
* Link YouTube videos that contain product information or tutorials
* Import custom knowledge bases or FAQs

## Monitor and Analyze Calls

Monitor and analyze your agent's phone conversations from the **Voice Call Recordings** tab. Filter calls by date range to find the ones you need.

<Frame>
  <img alt="Call Transcript" />
</Frame>

### Call Recordings and Transcript

* Listen to call recordings by clicking on **Play Recording** with playback speed controls
* View detailed transcripts with timestamps for each speaker
* Search through the transcript to find specific moments in the call
* Export call data for your records by clicking on **Export**

### Automated Call Analysis

After each call, we perform automated analysis to provide you with insights on the call:

<Frame>
  <img alt="Call Summary" />
</Frame>

* **Call Summary**: A concise overview of the entire conversation
* **Key Points**: Important details and decisions made during the call
* **Next Steps**: Action items identified from the conversation
* **Call Analysis**:
  * Sentiment analysis (Very Positive, Positive, Neutral, etc.)
  * Call intent (Appointment, Support, Inquiry, etc.)


# Shopify Agent
Source: https://docs.droxy.ai/documentation/agents/shopify

Learn how to create an agent that you can connect to your Shopify store.

<img alt="Shopify Agent" />

## What is a Shopify Agent?

It is an LLM-based agent that has access to your Shopify store's products and website content. The agent can answer complex questions about your products, make context-aware personalized recommendations to your visitors, and more.

You can embed the agent on your Shopify store's website in one simple click of a button.

## Setting Up Your Shopify Agent

If you do not have your Shopify store connected to Droxy yet, you can do so by following the instructions below.

### 1. Connect Your Shopify Store

To begin integrating your Shopify store with Droxy:

1. Navigate to **Settings** and select the **Stores** tab
2. Click on **Add** and select **Shopify** from the available options

<Frame>
  <img alt="Add Shopify Store" />
</Frame>

You will be redirected to your Shopify Store account to install the Droxy Shopify app. Follow the instructions in Shopify to complete the installation.

<Note>
  Once you connect your Shopify account, your billing will be processed through Shopify instead of Droxy. You'll maintain access to all your existing features and can upgrade, downgrade or cancel your subscription at any time through Shopify.
</Note>

After installation, you'll be redirected back to the Droxy dashboard for store configuration. You should see the following under the **Stores** tab in **Settings**. Click on the **Configure** button to continue.

<Frame>
  <img alt="Store Configuration" />
</Frame>

### 2. Configure Your Store

The configuration process involves two main steps with the goal of syncing your Shopify store's products and website content into Droxy's knowledge base.

#### Products Import

<Frame>
  <img alt="Configure Products" />
</Frame>

You'll see a list of all products that will be imported into Droxy. These products will serve as knowledge base for your agent.

<Warning>
  Each subscription plan has different product import limits. If your store exceeds the current plan's limit, you may need to upgrade to accommodate your full product catalog. Otherwise, a portion of your products will not be imported.
</Warning>

#### Website Content

<Frame>
  <img alt="Configure Website" />
</Frame>

Review and confirm the URLs that will be imported as part of your store's knowledge base. This ensures your agent has comprehensive information about your website content.

Once you've reviewed the imported products and website content, click on the **Sync** button to complete the configuration. The process may take a few minutes to complete depending on the size of your product catalog.

Once the process is complete, you should see the following under the **Stores** tab in **Settings**.

<Frame>
  <img alt="Store Configuration" />
</Frame>

### 3. Select Shopify Agent

In the Droxy dashboard, go to the **Agents** section and click on **+Add**. Then select **Shopify Agent**.

<Frame>
  <img alt="Shopify Agent" />
</Frame>

### 4. Select Connected Store

After syncing your store, you'll need to select which store to use for your agent. In the agent creation interface, you'll see your connected Shopify store listed:

<Frame>
  <img alt="Store Selection" />
</Frame>

Select your store by clicking on it. The checkmark will indicate your selection.

### 5. Add Additional Knowledge

Beyond your store's product and website content, you can add extra knowledge to enhance your agent's capabilities:

<Frame>
  <img alt="Additional Knowledge" />
</Frame>

Use the search bar to find specific knowledge items. Click **Add new** to upload additional resources such as:

* Company policies
* Return procedures
* Shipping information
* FAQs
* Other relevant documentation

### 6. Configuration

Configure your agent's behavior and capabilities:

<Frame>
  <img alt="Agent Configuration" />
</Frame>

Key configuration options include:

* **Behavior**: Define the agent's role, personality, and communication style. Be specific about how the agent should interact with customers. Use the built-in prompt generator to have optimized prompts automatically generated or modify them to match your needs.
* **Model**: Select the LLM powering your agent (e.g., GPT-4o mini, Claude Sonnet 4.6, Gemini 3 Flash). Each model consumes different amounts of tokens and has different capabilities.
* **Knowledge Restrictions**: Choose whether to restrict the agent's responses to only your provided knowledge content. Make sure to specify to the agent what to answer if the knowledge base doesn't contain an answer.
* **Emoji Support**: Enable or disable emoji usage in conversations

### 7. Customization

Personalize your chat widget's appearance to match your brand:

<Frame>
  <img alt="Customization Options" />
</Frame>

* **Agent Name**: Give your agent a name that reflects its role and your brand
* **Welcome Message**: Set an optional greeting message (up to 180 characters) that appears when customers start a conversation
* **Theme Selection**: Choose from pre-built color themes or create your own custom theme
* **Appearance**: Fully customize the look and feel of your chat widget including:
  * Agent's message color
  * User's message color
  * Accent color
  * Conversation background
  * Side bar background

All colors can be specified using hex codes for precise brand matching. The live preview window shows how your customization choices will appear to your customers.

### 8. Tools

You can enable the following tools to enhance your chat widget's functionality:

<Frame>
  <img alt="Available Tools" />
</Frame>

* **Lead Form**: Collect visitor contact information (email, phone, name) to capture and store leads for follow-up, seamlessly integrated into natural conversations.

* **Calendly**: Allow visitors to book meetings directly through the chat interface with automated scheduling. Perfect for sales teams, consultations, and support calls.

* **Email Handoff**: Transfer chat conversations to email when needed, especially useful for complex inquiries requiring detailed follow-up or when immediate chat resolution isn't possible.

Each tool can be toggled on/off using the switches, allowing you to customize the feature set based on your business needs.

## Embed the Agent on Your Shopify Store

Once you've configured and tested your agent, embedding it on your Shopify store is a simple one-click process:

1. Click the **Embed on store** button in the top-right corner of your agent's manage page
2. Wait a few minutes for the installation to complete

<Frame>
  <img alt="Embed on Store" />
</Frame>

That's it! Your agent will automatically appear on your Shopify store, ready to assist your visitors. There's no need for manual code installation or theme modifications - everything is handled seamlessly through the Shopify app integration.

<Note>
  The chat widget typically appears within 1-2 minutes of clicking the embed button. Once active, all your store visitors will be able to interact with your agent.
</Note>


# Website Agent
Source: https://docs.droxy.ai/documentation/agents/website

Learn how to create an agent that you can embed on your website.

<img alt="Website Agent" />

## What is a Website Agent?

It is an LLM-based agent that you can embed directly into your website to provide instant support and answers to your visitors. The agent:

* Learns from your company's knowledge sources including website content, PDFs, YouTube videos, and other documents
* Provides real-time responses to customer queries based on your specific business information
* Integrates seamlessly with your website through a simple embed script
* Answers in your brand's voice in a natural and conversational manner

## Setting Up Your Website Agent

In the Droxy dashboard, go to the **Agents** section and click on **+Add**. Then select **Website Agent**.

<Frame>
  <img alt="Website Agent" />
</Frame>

### 1. Knowledge Configuration

Before your agent can assist visitors, you'll need to ground it with knowledge. This will help it understand your business and answer questions more accurately.

<Frame>
  <img alt="Knowledge Configuration" />
</Frame>

1. Upload relevant company documents (PDFs, text files, Google Docs, etc.)
2. Add website URLs for the agent to learn from
3. Link YouTube videos that contain product information or tutorials
4. Import custom knowledge bases or FAQs

### 2. Agent Configuration

Configure your agent's behavior and capabilities:

<Frame>
  <img alt="Agent Configuration" />
</Frame>

Key configuration options include:

* **Behavior**: Define the agent's role, personality, and communication style. Be specific about how the agent should interact with visitors. Use the built-in prompt generator to create and refine your agent's instructions.
* **Model**: Select the LLM powering your agent (e.g., GPT-4o mini, Claude Sonnet 4.6, Gemini 3 Flash). Each model consumes different amounts of tokens and has different capabilities.
* **Knowledge Restrictions**: Choose whether to restrict the agent's responses to only your provided knowledge content. Make sure to specify to the agent what to answer if the knowledge base doesn't contain an answer.
* **Emoji Support**: Enable or disable emoji support in the chat widget.

### 3. Customization

Personalize your chat widget's appearance to match your brand:

<Frame>
  <img alt="Customization Options" />
</Frame>

* **Agent Name**: Give your agent a name that reflects its role and your brand
* **Welcome Message**: Set an optional greeting message that appears in a chat bubble when visitors first land on your website
* **Theme Selection**: Choose from pre-built color themes or create your own custom theme
* **Appearance**: Fully customize the look and feel of your chat widget including colors, backgrounds, and styling to match your brand identity

All colors can be specified using hex codes for precise brand matching. The live preview window shows how your customization choices will appear to your website visitors.

### 4. Website Bubble Settings

Configure how and where your chat widget appears on your website:

<Frame>
  <img alt="Website Integration" />
</Frame>

* **Allowed Domains**: Specify which domains can display your chat widget
  * Enter domains in the format: `https://www.example.com`
  * Add multiple domains if you want the agent to be available on multiple websites
  * By default, the agent will be available on all domains

* **Bubble Position**: Choose where the chat bubble appears on your website
  * Default position is "Bottom right"
  * Select the most appropriate location that won't interfere with your website's content

* **Welcome Message Display**: Control whether to show the welcome message bubble
  * Toggle between "Yes" or "No"
  * Useful for minimizing initial distractions while keeping the chat widget accessible

### 5. Tools

You can enable the following tools to enhance your chat widget's functionality:

<Frame>
  <img alt="Available Tools" />
</Frame>

* **Lead Form**: Collect visitor contact information (email, phone, name) to capture and store leads for follow-up, seamlessly integrated into natural conversations.

* **Appointment Scheduling**: Allow visitors to book meetings directly through the chat interface with automated scheduling. Perfect for sales teams, consultations, and support calls.

* **Email Handoff**: Transfer chat conversations to email when needed, especially useful for complex inquiries requiring detailed follow-up or when immediate chat resolution isn't possible.

Each tool can be toggled on/off using the switches, allowing you to customize the feature set based on your needs.

## Embed Agent on Your Website

Now that your agent is created and configured, you can embed it on your website. Before proceeding with the integration, we recommend testing your agent by clicking on the agent card in the dashboard to ensure it's working as expected.

To add your agent to your website:

<Frame>
  <img alt="Embed Menu" />
</Frame>

1. Click the `...` menu on your agent's card
2. Select **Embed on website**
3. Choose from two integration options:

<Frame>
  <img alt="Embed Code Options" />
</Frame>

### Option 1: Chat Bubble

Add a floating chat bubble that appears in the corner of your website. Simply add the provided script tag to your website's HTML before the closing `</body>` tag.

### Option 2: Iframe Integration

Embed the chat interface directly into your webpage using the provided iframe code. This is useful when you want to embed the chat interface in a specific location on your page.

Both integration methods will respect your customization settings and domain restrictions. Make sure your website's domain is listed in the allowed domains before implementing the embed code.

## Advanced Customization

You can customize your chat's appearance and sizing for both chat bubble and iframe integrations. This is particularly useful for accessibility needs or to better match your website's design.

### Chat Bubble Customization

For chat bubble integration, add data attributes to the script tag:

```jsx theme={null}
<script
  id="YOUR_AGENT_ID"
  src="https://app.droxy.ai/chat.min.js"
  data-base-font-size="18px"
  data-icon-size="24px"
  data-bubble-size="65px"
  data-widget-width="450px"
  data-widget-height="750px"
  data-allow-size-control="false"
  defer>
</script>
```

**Available Data Attributes:**

| Property                  | Description                                                                                                                                  | Default | Example          |
| ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ------- | ---------------- |
| `data-base-font-size`     | Base font size for all text in the chat widget. All typography scales relative to this value.                                                | `16px`  | `18px`, `20px`   |
| `data-icon-size`          | Size of all icons (width and height) in the chat widget                                                                                      | `20px`  | `24px`, `28px`   |
| `data-bubble-size`        | Diameter of the chat bubble                                                                                                                  | `50px`  | `60px`, `70px`   |
| `data-widget-width`       | Width of the chat widget container (desktop only, mobile will open in fullscreen)                                                            | `400px` | `450px`, `500px` |
| `data-widget-height`      | Height of the chat widget container (desktop only, mobile will open in fullscreen)                                                           | `700px` | `750px`, `80vh`  |
| `data-allow-size-control` | Whether to allow the user to control the size of the chat widget. If true, the user will be able to maximize the chat widget to full screen. | `false` | `true`           |

### Iframe Customization

For iframe integration, add URL parameters to the iframe src:

```jsx theme={null}
<iframe
  src="https://app.droxy.ai/guest-agent/YOUR_AGENT_ID?baseFontSize=18px&iconSize=24px"
  width="100%"
  height="100%"
  allow="microphone"
  frameborder="0">
</iframe>
```

**Available URL Parameters:**

| Parameter      | Description                                                                                   | Default | Example        |
| -------------- | --------------------------------------------------------------------------------------------- | ------- | -------------- |
| `baseFontSize` | Base font size for all text in the chat widget. All typography scales relative to this value. | `16px`  | `18px`, `20px` |
| `iconSize`     | Size of all icons (width and height) in the chat widget                                       | `20px`  | `24px`, `28px` |

### Common Use Cases

#### Mobile Accessibility

If users report that the text and icons are too small on mobile devices:

**Chat Bubble:**

```jsx theme={null}
<script
  id="YOUR_AGENT_ID"
  src="https://app.droxy.ai/chat.min.js"
  data-base-font-size="18px"
  data-icon-size="24px"
  data-bubble-size="65px"
  defer>
</script>
```

**Iframe:**

```jsx theme={null}
<iframe
  src="https://app.droxy.ai/guest-agent/YOUR_AGENT_ID?baseFontSize=18px&iconSize=24px"
  width="100%"
  height="100%"
  allow="microphone"
  frameborder="0">
</iframe>
```

#### Larger Widget for Desktop

For websites where you want a more prominent chat experience and want to allow the user to control the size of the chat widget:

**Chat Bubble:**

```jsx theme={null}
<script
  id="YOUR_AGENT_ID"
  src="https://app.droxy.ai/chat.min.js"
  data-widget-width="500px"
  data-widget-height="800px"
  data-allow-size-control="true"
  defer>
</script>
```

### Important Notes

* All properties are optional. If not specified, default values will be used.
* Font size changes affect all text in the widget proportionally (titles, body text, buttons, etc.)
* Icon size changes affect all icons in the widget (close buttons, send button, tool icons, etc.)
* Widget width and height only apply to desktop views. On mobile devices (screen width ≤ 500px), the widget automatically opens in fullscreen mode.


# Community Videos
Source: https://docs.droxy.ai/documentation/community-videos

Videos showcasing Droxy out in the wild.

### Agents Quickstart Guide

<iframe title="Agents Quickstart Guide" />

### Phone Agent Setup Guide

<iframe title="Phone Agent Setup Guide" />


# Overview
Source: https://docs.droxy.ai/documentation/contact/overview

Manage and organize all your contacts in one place

## What are Contacts?

Contacts in Droxy are individuals who have interacted with your agents. Every conversation is associated with a contact, and Droxy automatically extracts and creates contact records from these interactions.

With the Contacts page, you can:

* View all contacts across all your agents in one centralized location
* Search and filter contacts to find specific individuals quickly
* Manually add new contacts
* Edit and update contact information
* View conversation history for each contact
* Track all interactions a contact has had with your agents

Contacts are automatically created when someone starts a conversation with your agent. Droxy's AI extracts relevant information like name, email, phone number, and social profiles from the conversation and creates a comprehensive contact profile.

## Contacts Table

<Frame>
  <img alt="Contacts Overview" />
</Frame>

The Contacts page displays all your contacts in a table format. Each row shows key information about a contact including:

* **Name**: The contact's name
* **Email**: Email address
* **Phone**: Phone number
* **Social Profiles**: Links to Facebook, Instagram, and other social media profiles
* **Created At**: When the contact was first created

### Searching and Filtering Contacts

Use the search bar and filters to quickly find specific contacts by any property.

### Adding Contacts Manually

While Droxy automatically creates contacts from conversations, you can also manually add contacts by clicking the **Add Contact** button.

## Editing Contact Details

To view and edit a contact's full information, **double-click** on any row in the contacts table. This will open a detailed panel with three main sections:

<Frame>
  <img alt="Contact Details Panel" />
</Frame>

### Contact Information

View and edit all contact details:

* **Name**: Contact's full name
* **Email**: Email address
* **Phone**: Phone number
* **Social Profiles**: Links to Facebook, Instagram, and other social media profiles
* **Created At**: When the contact was first created
* **Last Updated**: Most recent update timestamp
* **Notes**: Additional notes or information about the contact

Click on any field to edit the information directly. Changes are saved automatically.

### Conversation History

View all conversations this contact has had with your agents:

* See a chronological list of all interactions
* Click on any conversation to view the full conversation thread
* Quickly understand the complete relationship history with this contact

This section helps you understand the full context of your relationship with each contact and provides insights into their journey with your business.


# Unlimited Usage
Source: https://docs.droxy.ai/documentation/enterprise/byok

Use your own API keys for unlimited usage at provider rates

<Card title="Enterprise Feature" icon="building">
  This feature is available exclusively for Enterprise plan customers.
</Card>

## What are External Providers?

External providers allow enterprise customers to connect their own API keys from leading AI services directly to Droxy, bypassing Droxy's usage system for cost-effective unlimited usage. Instead of consuming Droxy tokens, your agents and knowledge items will use your own credits directly with the provider.

Key Benefits:

* **Direct provider pricing** - Pay exactly what OpenAI, OpenRouter, and other providers charge per token/second
* **Cost control** - Manage your own spending and billing relationship
* **No usage limits** - Never worry about running out of Droxy tokens again

## OpenRouter

* **What it covers:** Message tokens (e.g. Website Agent, WhatsApp Agent, etc.)
* **Use case:** High-volume messaging scenarios with access to multiple LLM models
* **Benefits:** Covers all text-based models available on Droxy

### Setup

#### 1. Create an OpenRouter Account

Visit [OpenRouter.ai](https://openrouter.ai) and create your account.

<Frame>
  <img alt="OpenRouter Landing Page" />
</Frame>

#### 2. Sign Up and Generate API Key

After signing up, navigate to the API Keys section to create your key.

<Frame>
  <img alt="OpenRouter API Keys Page" />
</Frame>

#### 3. Add Credits

Access the Credits menu from the navigation bar:

<Frame>
  <img alt="OpenRouter Credits Menu" />
</Frame>

Load credits to your account to start using the service:

<Frame>
  <img alt="OpenRouter Credits Page" />
</Frame>

<Note>
  Enable automatic refill in your OpenRouter account to ensure your agents continue working when credits run low. This prevents service interruption due to insufficient credits.
</Note>

#### 4. Activate in Droxy

<Warning>
  You must add credits to your OpenRouter account before you can successfully add your API key to Droxy. Without credits, the API key validation will fail and cannot be activated.
</Warning>

1. Navigate to **Settings** > **External providers** in your Droxy dashboard
2. Find the **OpenRouter** card
3. Enter your OpenRouter API key
4. Toggle the switch to **Enable**
5. Click **Save** to validate and activate the integration

<Frame>
  <img alt="Activate OpenRouter Key in Droxy" />
</Frame>

## OpenAI

<Warning>
  For text-based agents (Website Agent, WhatsApp Agent, etc.), even when using OpenAI models, you need to use OpenRouter as your external provider, not OpenAI. The OpenAI external provider is exclusively for Voice Call Seconds (Phone Agents) and Knowledge Tokens.
</Warning>

* **What it covers:** Voice call seconds and knowledge tokens (embeddings)
* **Use case:** Organizations with high voice usage or large knowledge bases
* **Benefits:** Direct OpenAI pricing for voice and embeddings processing

### Setup

#### 1. Generate API Key

Visit [platform.openai.com/api-keys](https://platform.openai.com/api-keys) to access your API keys dashboard.

<Frame>
  <img alt="OpenAI API Keys Page" />
</Frame>

#### 2. Create New API Key

Click **Create new secret key** to generate your API key.

<Frame>
  <img alt="Create OpenAI API Key" />
</Frame>

#### 3. Activate in Droxy

1. Navigate to **Settings** > **External providers** in your Droxy dashboard
2. Find the **OpenAI** section
3. Enter your OpenAI API key
4. Toggle the switch to **Enable**
5. Click **Save** to validate and activate the integration

<Frame>
  <img alt="Activate OpenAI Key in Droxy" />
</Frame>

## Usage

Once activated, your configured external providers will automatically be used instead of Droxy's internal tokens and credits. You can use as much as your provider credit balances allow, with pricing directly from each model provider.

<Note>
  External provider integration only applies to the specific services covered by each provider. Other Droxy features and limitations remain unchanged.
</Note>


# White Label
Source: https://docs.droxy.ai/documentation/enterprise/whitelabel

Use your own domain to share and embed your Droxy agents

<Card title="Enterprise Feature" icon="building">
  This feature is available exclusively for Enterprise plan customers.
</Card>

## Why Use Your Own Domain?

If you are an agency or a business, you can use your own domain for your agents. This way, the share links and embed code snippets of your agents will have your own domain name.

Benefits:

* Your agents will look more professional
* You can use your own or your client's branding/domain
* Present AI agents as part of your agency's service offering
* Build client trust by delivering AI solutions under their brand

## Setup Guide

### 1. Add Your Domain

Navigate to **Integrations** > **White Label** in your Droxy dashboard, click on **Add**, enter your domain name and confirm. The creation process will begin and can take up to 10 minutes.

<Frame>
  <img alt="Add Domain" />
</Frame>

### 2. Add the CNAME Record to Your DNS

After the creation process is complete, you will see the CNAME record to add to your DNS. This record is used to prove that you own the domain. Copy the CNAME record's host and value and add it to your DNS.
Depending on your DNS provider, the process to add the CNAME record may vary. The verification can take up to 30 minutes to complete because the DNS records need to propagate.

<Frame>
  <img alt="Add CNAME Verification" />
</Frame>

### 3. Configure Your White Label URL

After the CNAME record is verified, you can configure your white label URL using either your root domain or a subdomain:

* **Use a subdomain** (recommended): Choose this option if you already have a website on your domain (e.g., if example.com is your company website, use agents.example.com for your Droxy agents). This is the most common setup as it keeps your main website separate from your agents.

* **Use root domain**: Choose this option only if you have a dedicated domain specifically for your Droxy agents and don't plan to host anything else on it (e.g., using myagents.com exclusively for Droxy).

The following sections will guide you through the setup process for both options.

<Frame>
  <img alt="Add White Label URL" />
</Frame>

#### 3.1 Use your Root Domain

To use your root domain, toggle the switch to enable it. Then add the displayed ANAME record to your DNS. Some DNS providers will call it ALIAS records. ANAME or ALIAS records are the same type of record. After the DNS propagation is complete, try accessing your domain from the browser.
You should see a page from Droxy.

<Frame>
  <img alt="Use Root Domain" />
</Frame>

#### 3.2 Use a Subdomain

To use a subdomain, click on **Add a subdomain**.

<Frame>
  <img alt="Add Subdomain" />
</Frame>

Enter the subdomain name and confirm.

<Frame>
  <img alt="Use Subdomain" />
</Frame>

After the subdomain is created, you will see the CNAME record to add to your DNS. Copy the CNAME record's host and value and add it to your DNS. After the DNS propagation is complete, try accessing your domain from the browser.
You should see a page from Droxy.

<Frame>
  <img alt="Subdomain CNAME" />
</Frame>

### 4. Use the White Label URL with your agents

After the domain is created and the DNS records are added, you can use the white label URL with your agents. When sharing your agent, if the white label domain can be used, you will see the option to use your own domain in the **White label domain** dropdown. Select the domain you want to use with that agent.

After selecting the domain for your agent, the share links and the code snippets will have your white label domain!

<Frame>
  <img alt="Use White Label URL" />
</Frame>

Refer to the [Sharing](/documentation/sharing/agent) documentation for more information on how to share your agent.

## Troubleshooting

<Warning>
  DNS records can take up to 30 minutes to propagate. Please be patient and check back later.
</Warning>

### How to validate the A/CNAME records are correctly configured?

You can use a tool like [DNS Checker](https://dnschecker.org/all-dns-records-of-domain.php) to validate the A/CNAME records are correctly configured.

### I added the records to use my root domain or a subdomain, how can I check if it's working?

After adding the records, you can check if it's working by accessing your domain from the browser. You should see a page from Droxy. If you don't see a page from Droxy, please refer to the [How to validate the A/CNAME records are correctly configured?](#how-to-validate-the-a%2Fcname-records-are-correctly-configured%3F) section to verify the records are correctly configured.
Please note that DNS changes can take up to 30 minutes to propagate.

### CAA records

CAA records add restrictions on who can issue SSL/TLS certificates for a custom domain, so your site works via HTTPS. If you have one or more CAA records in your DNS configuration, you will need to add a new CAA record to your DNS configuration.
Droxy uses AWS to issue SSL/TLS certificates for your domain. In order to use AWS to issue certificates, you need to add the following CAA record to your DNS configuration:

```
Domain        Type    Flags    Tag     Value
example.com   CAA     0        issue   "amazontrust.com"
```


# Custom Conversation Extraction
Source: https://docs.droxy.ai/documentation/inbox/custom-conversation-extraction

Customize your conversation analysis to extract specific information that matters to your business

## What is Custom Conversation Extraction?

Custom Conversation Extraction allows you to define exactly what information you want Droxy to extract and analyze from every conversation. Instead of relying only on default analysis, you can create a custom schema that automatically extracts business-critical data points tailored to your specific needs.

This powerful feature uses AI to intelligently identify and extract the information you specify, turning every conversation into structured, actionable data that you can filter, analyze, and act upon.

## How to Configure Custom Conversation Extraction

<Frame>
  <img alt="Custom Conversation Extraction Configuration" />
</Frame>

1. From your agent's dashboard, click the **Advanced** section
2. Scroll to the **Custom Conversation Extraction** accordion
3. Click **Add Field** to create a new extraction field
4. Configure your custom analysis fields (see examples below)
5. Click **Save** to apply your configuration

Once configured, Droxy will automatically analyze all future conversations with your agent and extract the specified information.

## Field Types and Examples

You can create extraction fields with different data types to capture various kinds of information:

### String Fields

Extract text-based information with predefined values or free-form text.

<Frame>
  <img alt="String Fields" />
</Frame>

**Example: Lead Quality**

* **Field Name**: `Lead Quality`
* **Description**: "Quality of the lead for sales purposes based on budget, timeline, and fit indicators"
* **Type**: String with predefined values
* **Values**: `hot`, `warm`, `cold`, `not_applicable`

**Example: Product Mention**

* **Field Name**: `Product Mention`
* **Description**: "The specific product, service, or feature name discussed in the conversation"
* **Type**: String (free-form)

### Enumerated Values

Create fields with specific options to categorize conversations consistently.

<Frame>
  <img alt="Enum Fields" />
</Frame>

**Example: Urgency Level**

* **Field Name**: `Urgency`
* **Description**: "How urgently this conversation needs attention or follow-up"
* **Type**: Enum
* **Values**: `low`, `medium`, `high`, `critical`

**Example: Department Routing**

* **Field Name**: `Department`
* **Description**: "Which department should handle this conversation"
* **Type**: Enum
* **Values**: `sales`, `support`, `billing`, `technical`, `general`

### Number Fields

Extract numerical data for quantitative analysis and scoring.

<Frame>
  <img alt="Number Fields" />
</Frame>

**Example: Satisfaction Score**

* **Field Name**: `Satisfaction Score`
* **Description**: "Satisfaction score on a scale of 1 to 10 based on the customer's tone and sentiment"
* **Type**: Number (1-10)

**Example: Budget Mentioned**

* **Field Name**: `Budget Amount`
* **Description**: "Budget or price range mentioned by the customer"
* **Type**: Number

### Boolean Fields

Extract yes/no information for binary classification.

<Frame>
  <img alt="Boolean Fields" />
</Frame>

**Example: Demo Requested**

* **Field Name**: `Demo Requested`
* **Description**: "Whether the customer requested a product demonstration"
* **Type**: Boolean

**Example: Competitor Mentioned**

* **Field Name**: `Competitor Mentioned`
* **Description**: "Whether the customer mentioned using or considering a competitor"
* **Type**: Boolean

### Array Fields

Extract multiple values or items from a single conversation.

<Frame>
  <img alt="Array Fields" />
</Frame>

**Example: Objections Raised**

* **Field Name**: `Objections Raised`
* **Description**: "Specific concerns, hesitations, or objections expressed by the customer"
* **Type**: Array of strings

**Example: Pain Points**

* **Field Name**: `Pain Points`
* **Description**: "Specific problems or challenges mentioned by the customer"
* **Type**: Array of strings

## What You Can Unlock

Custom Conversation Extraction opens up powerful possibilities for your business:

### Sales Intelligence

* **Qualify Leads Automatically**: Extract lead quality, budget, timeline, and decision-making authority to prioritize follow-ups
* **Track Product Interest**: Identify which products or features customers are most interested in
* **Detect Buying Signals**: Capture urgency indicators, budget mentions, and timeline references
* **Competitive Analysis**: Track competitor mentions and understand why customers are comparing options

### Customer Success

* **Measure Satisfaction**: Automatically score customer satisfaction based on conversation tone and sentiment
* **Identify At-Risk Customers**: Flag conversations with negative sentiment or complaint indicators
* **Track Feature Requests**: Capture and categorize product feedback and feature requests
* **Monitor Support Quality**: Extract resolution status, response quality, and customer satisfaction

### Marketing Insights

* **Understand Customer Needs**: Extract pain points, challenges, and goals mentioned in conversations
* **Track Campaign Performance**: Identify how customers heard about you and which campaigns drive conversations
* **Content Opportunities**: Discover frequently asked questions that could become blog posts or FAQs
* **Persona Development**: Build detailed customer personas based on extracted conversation data

### Operations and Analytics

* **Filter and Segment**: Use extracted data to filter conversations in your inbox by any custom field
* **Export for Analysis**: Export conversations with custom fields to analyze trends and patterns
* **Automate Workflows**: Use extracted data to trigger automations (via Zapier or API integrations)
* **Report to Stakeholders**: Create dashboards and reports based on structured conversation data

## Best Practices and Tips

**Start Simple**: Begin with 3-5 essential fields that align with your most important business metrics. You can always add more later.

**Use Clear Descriptions**: The AI uses your field descriptions to understand what to extract, so be specific and detailed about what you're looking for.

**Predefined Values Work Best**: For categorical data, provide predefined values rather than free-form text. This ensures consistency and makes filtering easier.

**Review and Iterate**: Check your extracted data regularly to ensure the AI is capturing information accurately. Refine your descriptions if needed.

**Export for Deeper Analysis**: Regularly export your conversation data with custom fields to spreadsheets for trend analysis and business intelligence.

**Consider Your Team's Needs**: Involve sales, support, and other teams when designing extraction fields to ensure you're capturing data that everyone can use.


# Overview
Source: https://docs.droxy.ai/documentation/inbox/overview

Manage all your agent conversations in one unified view

## What is the Inbox?

The Inbox is your central hub for managing all conversations across all your agents. Instead of viewing conversations agent by agent, the Inbox provides a unified view where you can monitor, filter, and manage every customer interaction in one place.

With the Inbox, you can:

* View all conversations from all your agents in a single feed
* Filter and search through conversations efficiently
* Take over conversations to provide human assistance when needed
* Access detailed conversation analysis and insights
* Manage contact information automatically extracted from conversations

The Inbox is organized into three main sections: the conversation list on the left, the conversation view in the middle, and the details panel on the right.

<Frame>
  <img alt="Inbox Overview" />
</Frame>

## Conversation List

The left panel displays all conversations across your agents. Each conversation shows key information like the contact name, last message preview, timestamp, conversation status, tags and associated agent.

### Filtering Conversations

Use the filter options to quickly find specific conversations:

* **By Date**: Filter conversations from a specific time period or date range
* **By Source**: Filter by conversation source (website, WhatsApp, Instagram, phone, etc.)
* **By Analysis Results**: Filter based on AI-analyzed conversation data like sentiment, intent, or custom analysis fields
* **By Tags**: Filter conversations by assigned tags for easy categorization
* **By Status**: Filter by conversation status (resolved, takeover, spam, etc.)
* **By Agent**: Filter conversations handled by specific agents
* **By Contact**: Filter conversations with specific contacts

## Conversation View

The middle panel displays the full conversation thread for the selected conversation. You can read through the entire exchange between the agent and the contact.

### Conversation Actions

Click the actions button at the top right corner of the conversation view to access available actions:

<Frame>
  <img alt="Conversation Actions Menu" />
</Frame>

Available actions include:

* **Create Memory**: Save important information from this conversation to the agent's long-term memory, helping it remember context for future interactions with this contact.
* **Mark as Spam**: Flag a conversation as spam or irrelevant, helping improve your inbox quality. Agent will stop responding to the conversation.
* **Take Over**: Manually take control of the conversation to provide human assistance. The agent will stop responding and you can reply directly to the contact.
* **Handoff**: Mark the conversation as resolved or unresolved after a human agent has provided assistance.

## Details Panel

The right panel provides in-depth information about the selected conversation. It's split into two sections: Conversation Details and Contact Information.

### Conversation Details

View comprehensive information about the conversation:

* **Properties**: Relevant information about the conversation like source, agent, status, tags, created at and last updated at.
* **Recording**: Voice call recording (if available)
* **Analysis**: AI-analyzed conversation data like sentiment, intent, resolution status, key topics and custom properties.

Droxy can automatically analyze each conversation to extract valuable insights such as summary, key points, next steps and custom properties.

You can customize which analysis fields are captured and displayed by configuring your conversation analysis settings in your agent's advanced settings. Learn more about custom conversation extraction in the [custom conversation extraction documentation](/documentation/inbox/custom-conversation-extraction).

### Contact Information

Every conversation is associated with a contact. The contact information section displays:

* **Name**: Contact's name (automatically extracted or provided)
* **Email**: Contact's email address
* **Phone**: Contact's phone number
* **Social Profiles**: Contact's social profiles (Facebook, Instagram, etc.)
* **Created At**: The date and time the contact was created
* **Last Updated At**: The date and time the contact was last updated
* **Notes**: Any additional notes about the contact

You can learn more about contacts in the [contact documentation](/documentation/contact/overview).


# Cal.com
Source: https://docs.droxy.ai/documentation/integrations/caldotcom

Learn how to connect your Cal.com account to Droxy

<img alt="Cal.com" />

## Overview

To enable your Phone Agents to schedule appointments, you'll need to connect your Cal.com account to Droxy. This integration allows your agents to:

* Check real-time calendar availability
* Connect other calendars (Google, Apple, Outlook, etc.)
* Book appointments directly into your calendar
* Handle time zone conversions
* Send confirmation emails to attendees

## Create a Cal.com Account

1. Visit [Cal.com](https://cal.com) to create your account

<Frame>
  <img alt="Cal.com Landing Page" />
</Frame>

## Connect Your Cal.com Account

### 1. Generate an API Key

First, you'll need to create an API key in your Cal.com account:

1. Go to Settings in your Cal.com dashboard

<Frame>
  <img alt="Settings Menu" />
</Frame>

2. Select **API Keys** from the sidebar menu

<Frame>
  <img alt="API Keys Menu" />
</Frame>

3. Click **Add** to create a new API key

<Frame>
  <img alt="Add API Key" />
</Frame>

4. Configure your API key:
   * Enter a descriptive name (e.g., "Droxy Integration")
   * **Important**: Set the expiration to **Never expires** to prevent integration disruption
   * Click **Save**

<Frame>
  <img alt="Save API Key" />
</Frame>

5. **Copy the generated API key** - you'll need this in the next step

### 2. Add Cal.com to Droxy

Now that you have your API key, connect it to Droxy:

1. In your Droxy dashboard, go to **Settings** > **Integrations**
2. Find and select **Cal.com**

<Frame>
  <img alt="Select Cal.com Integration" />
</Frame>

3. Click **Connect** to add a new account

<Frame>
  <img alt="Connect Account" />
</Frame>

4. Enter your Cal.com API key

<Frame>
  <img alt="Enter API Key" />
</Frame>

5. Click **Connect** to complete the integration

Droxy will validate your API key and establish the connection. Once connected, you can start using the Appointment Scheduling tool with your Phone Agents.

## Connect Your Business Calendar

You can connect your existing business calendar (Google Calendar, Outlook, Apple, etc.) to Cal.com, which will then be available to your Droxy Phone Agents. This means appointments booked through your agents will appear directly in your business calendar.

### Connect a Calendar

1. In your Cal.com dashboard, go to **Settings** > **Calendars**

<Frame>
  <img alt="Add Calendar" />
</Frame>

2. Click **Add Calendar** to see the available calendar integrations

<Frame>
  <img alt="Calendar Options" />
</Frame>

3. Select your calendar provider and follow the authentication steps

Once connected, your Phone Agents will automatically:

* Check for conflicts with your existing calendar events
* Book new appointments directly into your calendar
* Ensure no double bookings occur

<Note>
  Make sure to:

  * Enable the connected calendar in your availability settings to check for conflicts
  * Configure your event types to book appointments into this calendar
    Otherwise, the booked appointments won't show up in your calendar.
</Note>

For a detailed walkthrough of calendar setup, you can watch Cal.com's [video tutorial](https://www.youtube.com/watch?v=OUOume6QKuw).

## Next Steps

After connecting your Cal.com account:

1. [Create Event Types](/documentation/agents/phone/appointments#prerequisites) for your appointments
2. [Configure your availability](/documentation/agents/phone/appointments#3-configure-availability-settings) in Cal.com
3. [Add the Appointment Scheduling tool](/documentation/agents/phone/appointments#setting-up-the-tool) to your Phone Agent

## Troubleshooting

If you encounter any issues:

* Verify that your API key is set to never expire
* Ensure you've copied the full API key correctly
* Check that your Cal.com account has active event types configured
* Confirm your availability settings are properly set up


# Phone Numbers / Twilio
Source: https://docs.droxy.ai/documentation/integrations/phone-numbers

Learn how to import phone numbers that you can connect to your agents

<img alt="Phone Numbers" />

## Overview

To enable customers to reach your [Phone Agent](/documentation/agents/phone), you'll need to connect it to a phone number. This number can then be shared on your website, Google Maps listing, business cards, or any other customer touchpoint.

There are two ways to get a phone number in Droxy:

1. Get a free **US/Canada** number through Droxy (paid plans only)
2. Import your existing **Twilio** number (any country)

## Adding a Phone Number

1. Navigate to **Settings** > **Integrations** in your Droxy dashboard
2. You should see the **Phone Numbers** integration in the list. Click on it.

<Frame>
  <img alt="Add Number" />
</Frame>

3. You should see the **Phone Numbers** page where you can manage existing numbers and add new ones.

<Frame>
  <img alt="Phone Numbers" />
</Frame>

### Option 1: Get a Number Through Droxy

If you're on a paid plan, you can get a free phone number for use in the US or Canada:

1. Click the **Get New Number** button

<Frame>
  <img alt="Get New Number" />
</Frame>

2. Select your desired country (US/Canada)
3. Browse available numbers by region/area code
4. Select your preferred number from the list
5. Click **Continue** to add the number to your account

### Option 2: Import from Twilio

For numbers **outside the US/Canada**, or if you prefer to use **your own Twilio account**, you can import an existing Twilio number:

<Note>
  Numbers outside the US/Canada require additional verification processes in Twilio due to telephony provider requirements. We recommend importing these through your Twilio account for a smoother experience.
</Note>

1. First, get a number from Twilio by following [this official guide](https://help.twilio.com/articles/223135247-How-to-Search-for-and-Buy-a-Twilio-Phone-Number-from-Console) for your desired country and region

2. **Set up an Elastic SIP Trunk** in your Twilio account to connect calls to Droxy's voice agent:

<Note>
  The Elastic SIP Trunk setup is required to route incoming calls from your Twilio number to Droxy's voice agent infrastructure. For more detailed information about Elastic SIP Trunks, you can read [Twilio's official documentation](https://www.twilio.com/docs/sip-trunking). Once you've completed these steps and imported your number, you can attach it to your Phone Agent and start receiving calls!
</Note>

2.1 In your [Twilio Console](https://console.twilio.com/), search for "Elastic SIP Trunks" and click on **Elastic SIP Trunks**

<Frame>
  <img alt="Search for Elastic SIP Trunks" />
</Frame>

2.2 Click **Create new SIP Trunk**

<Frame>
  <img alt="Create New SIP Trunk" />
</Frame>

2.3 Enter a name for your trunk (e.g., `droxy-trunk`) and click **Create**

<Frame>
  <img alt="Create Trunk Modal" />
</Frame>

2.4 Configure your trunk settings:

In the **General** tab, enable call transfer by toggling the **Call Transfer** switch, then check the **Enable PSTN Transfer** checkbox, then click **Save**

<Frame>
  <img alt="Enable Trunk Transfer" />
</Frame>

In the **Origination** tab, navigate to the **Origination URIs** section and click the **+** button to add a new origination URI

<Frame>
  <img alt="Add Origination URI" />
</Frame>

Enter `sip:686zak658y9.sip.livekit.cloud` as the Origination SIP URI and click **Save**

<Frame>
  <img alt="Add Origination URI Modal" />
</Frame>

3. In your **Integrations** > **Phone Numbers** page, click **Import from Twilio**

<Frame>
  <img alt="Import Number" />
</Frame>

4. You'll need to provide:
   * Your Twilio phone number (in international format, e.g., +1XXXXXXXXXX)
   * Twilio Account SID (found in your [Twilio Console](https://console.twilio.com/))
   * Twilio Auth Token (found in your [Twilio Console](https://console.twilio.com/))
5. Click **Import** to complete the process

<Warning>
  **Trial Account Limitation**: If you're testing with a Twilio trial account and hear a message saying "this phone number isn't configured to take inbound calls" when calling your number, this is likely due to Twilio's trial account restrictions ([Error 21264](https://www.twilio.com/docs/api/errors/21264)).

  Trial accounts can only receive calls from verified caller IDs. You can either:

  * **Upgrade your Twilio account** to remove this limitation, or
  * **Add your test phone number as a verified caller ID** by following [this guide](https://help.twilio.com/articles/223180048-How-to-Add-and-Remove-a-Verified-Phone-Number-or-Caller-ID-with-Twilio) or directly in your [Twilio Console Verified Caller IDs section](https://console.twilio.com/us1/develop/phone-numbers/manage/verified)
</Warning>

## Managing Phone Numbers

After adding a phone number, you will see it in the list below. You can then follow this [guide](/documentation/agents/phone#3-connect-your-phone-number) to connect it to a Phone Agent.

<Note>
  You can only connect one number to each Phone Agent. Once connected, you can disconnect it and connect to a different number.
</Note>

<Frame>
  <img alt="Number List" />
</Frame>


# Introduction
Source: https://docs.droxy.ai/documentation/introduction

Explore our comprehensive guides to get the most out of Droxy.

<div>
  <iframe alt="Welcome to Droxy - Video" title="Welcome to Droxy - Video" />
</div>

## Why use Droxy?

Businesses are often leaving money on the table because they don't have the resources to respond to all customer interactions quickly and effectively enough. Whether it's web-chat messages, phone calls, or social media DMs, unanswered customer questions often mean lost revenue.

Droxy is a platform that allows you to create customer facing agents that know everything about your business and talk in your brand's voice. These agents can handle a wide range of customer inquiries across various channels. They are easy to build, manage, monitor and scale. You can have an agent ready to talk to your customers in minutes!

## What are agents?

Droxy's agents are customer facing LLM (Large Language Model) based AIs that are designed to handle a wide range of customer interaction tasks without human intervention. They have the knowledge of your business, can communicate in your brand's voice, and are capable of handling customer inquiries across channels like your website, social media, phone and more. These agents can qualify leads, book appointments, and response to complex customer questions about your products and services. Checkout one of our [guides](/documentation/agents/website-agent) on how to setup your first agent.

## Integrations

Droxy integrates with your existing tech stack so you can get started quickly. For agents' knowledge, we support a wide range of [data sources](/documentation/knowledge/overview) like websites, PDFs, Google Drive, Youtube, and more. For agent deployment, we support social media channels like Facebook, Instagram. We support messaging apps like WhatsApp and Messenger. We support voice channels like phone numbers and custom SIP trunks.

If you need something more custom, we offer a Zapier integration to connect Droxy to any app without code, and we also offer a [custom API](/api-reference/introduction) to integrate Droxy with your own systems.

## Subscriptions

We offer four different subscription tiers to suit businesses of all sizes: **Starter** (Free), **Basic**, **Advanced**, and **Enterprise**. You can visit our [pricing page](https://droxy.ai/pricing) to learn more about what's included in each plan. For all plans, we provide the flexibility to upgrade, downgrade, or cancel your subscription at any time, so you can adjust as your business needs evolve. If you are looking for custom limits or need dedicated consultation, feel free to contact us at [contact@droxy.ai](mailto:contact@droxy.ai).


# Datasources
Source: https://docs.droxy.ai/documentation/knowledge/datasources

Learn about the various knowledge datasources for your agents.

<img alt="Datasources" />

## Overview

Business knowledge is typically distributed across numerous different sources. That's why we've developed multiple integrations and support various file formats, enabling you to import as much knowledge as possible into Droxy for use with your agents.

## Adding Knowledge Sources

To import a knowledge item:

1. Navigate to the **Knowledge** tab in your Droxy dashboard
2. Click the **+Add** button in the top right corner

<Frame>
  <img alt="Add Knowledge Modal" />
</Frame>

3. A modal will appear allowing you to select your knowledge source type and upload it:

<Note>
  Note that you don't have to add one knowledge item at a time. You can add multiple items at once.
</Note>

<Frame>
  <img alt="Add Knowledge Modal" />
</Frame>

## Supported Datasources

### PDF

PDF documents are a common source of business knowledge. Our PDF processor extracts text content from your PDF files while maintaining the original structure and formatting.

Upload Requirements:

* Upload up to 5 PDF files simultaneously
* Maximum total upload size: 1000MB per batch

<Note>
  Important requirements for PDF processing:

  * PDFs must contain selectable text (you should be able to highlight and copy text)
  * Images within PDFs are not processed or extracted
  * Scanned PDFs without text recognition cannot be processed
</Note>

### YouTube

You can add YouTube content in two ways:

1. Paste a direct video link
2. Search for videos directly in the modal and then select the ones you want to add

<Frame>
  <img alt="YouTube Knowledge Import" />
</Frame>

### Google Drive

1. Connect your Google Drive account
2. Select individual files or entire folders to import
3. Content will be automatically processed and added to your knowledge base

### Website

Import knowledge from websites in two ways:

<Frame>
  <img alt="Website Knowledge Import" />
</Frame>

1. **Single Link**: Add a specific URL and click **Add single Link**
2. **Crawl Website**: Extract content from multiple pages
   * Enter the root URL (e.g., `https://www.droxy.ai`)
   * Click **Fetch sub-links** to discover all available pages
   * For sites with a sitemap, links will be automatically fetched

<Frame>
  <img alt="Website Sublinks Selection" />
</Frame>

After fetching, you can:

* Select specific URLs or use **Select All**
* Click **Add website** followed by **Upload** to import content

<Frame>
  <img alt="Website Upload" />
</Frame>

### Text

For content not available in other formats, use direct text input:

* Paste raw text directly into the interface
* Perfect for custom or unique knowledge sources

<Frame>
  <img alt="Text Knowledge Input" />
</Frame>

### MP4

Upload video files directly to add them as knowledge sources. Droxy automatically extracts audio from the video, transcribes it, and converts it into usable knowledge for your agent:

Upload Requirements:

* Maximum duration: 120 minutes
* Maximum file size: 1000MB
* Supported format: MP4 only

<Note>
  For best results:

  * Use clear audio with minimal background noise
  * Record with a high-quality microphone
  * Avoid multiple speakers talking at once
</Note>


# Overview
Source: https://docs.droxy.ai/documentation/knowledge/overview

Learn about the importance of knowledge for your agents.

<img alt="Knowledge Overview" />

## Importance of Knowledge for Your Agents

Your agent's knowledge base is the foundation of its ability to provide accurate, relevant, and business-specific responses. While Large Language Models (LLMs) possess broad general knowledge, they need your specific business information to truly represent your brand and serve your customers effectively.

### What Knowledge Does Your Agent Need?

Think of your agent as a new employee joining your team. Just as you would provide comprehensive training materials to ensure they understand your:

* Product details and specifications
* Company policies and procedures
* Brand voice and communication guidelines
* Customer service protocols
* Frequently asked questions
* Technical documentation

Your AI agent needs similar knowledge to perform effectively. Without proper knowledge configuration, even the most advanced LLM can only provide generic responses that may not align with your business needs.

### Impact on Response Quality

When you provide your agent with high-quality, relevant knowledge:

* It can answer specific questions about your products and services with precision
* Responses align perfectly with your company policies and procedures
* Communication maintains consistency with your brand voice
* Customer inquiries are handled according to your established protocols
* Complex technical questions can be addressed with accurate, documented information

To build this knowledge base effectively, start by gathering the essential materials you use for employee training—including product manuals, internal wikis, company policies, and customer service guidelines. These resources will serve as the foundation for your agent's expertise.


# Automatic Sync
Source: https://docs.droxy.ai/documentation/knowledge/sync

Keep your knowledge sources up to date with automatic sync

<img alt="Automatic Sync" />

## Why Automatic Sync?

Knowledge is dynamic and constantly evolving. While human employees stay updated through announcements and documentation updates, AI agents need a systematic way to maintain current knowledge. This is where automatic sync becomes crucial.

The automatic sync feature ensures your AI agents always have access to the most up-to-date information, enabling them to:

* Provide accurate responses based on current information
* Stay aligned with latest company policies and procedures
* Reflect recent product updates or changes
* Maintain consistency with current business practices

## How to Configure Automatic Sync

Automatic sync is currently available for **Website** and **Google Drive** knowledge data sources. You can configure sync settings in two ways:

### During Initial Upload

When uploading a new resource, select your preferred sync frequency from the dropdown menu:

<Frame>
  <img alt="Sync Frequency" />
</Frame>

### After Upload

You can modify the sync frequency for existing knowledge items at any time:

<Frame>
  <img alt="Change Sync Frequency" />
</Frame>

1. Navigate to the **Knowledge** section
2. Click the menu icon `⋮` next to the knowledge item
3. Select **Edit sync status**
4. Choose your desired sync frequency

## Sync Process

<Note>
  The sync process uses knowledge tokens for each sync operation. Make sure to select a sync frequence that is appropriate for your plan and the nature of your knowledge item.
</Note>

Once configured, the sync process works automatically:

* Droxy retrieves and updates knowledge at your specified interval
* The knowledge item is refreshed with the latest content
* Agents using this knowledge item immediately gain access to the updated information
* No manual intervention is required to maintain current knowledge


# Agent
Source: https://docs.droxy.ai/documentation/sharing/agent

Learn how to share your Droxy agent

## Why Share Your Agents?

Droxy allows you to share your agent with others. You can share your agent with your team, with your clients, or with the public.
The sharing feature lets you distribute access to your AI agent through a simple shareable link. Once shared, users can interact with your agent.
You can also revoke or modify access at any time through the sharing settings.

## How to Share Your Agent?

### 1. Open the Sharing Settings

Open the sharing settings by clicking on the **Share** button on the agent's dropdown menu.

<Frame>
  <img alt="Share Button" />
</Frame>

### 2. Select the Sharing Configuration

Select the sharing configuration you want to use.

#### 2.1 Select the Accessibility

Select the accessibility of the agent.

<Frame>
  <img alt="Share Accessibility" />
</Frame>

* **Public**: Make the agent accessible to everyone.
* **Private**: Make the agent accessible to everyone but protected with a password.
* **Protected**: Make the agent accessible only to you.

#### 2.2 Select Your White-Label Domain

If you want your agent to have a white-labeled domain when sharing the agent with others (e.g., `https://agent.example.com`), you can set it up here.

<Frame>
  <img alt="Share White-Label Domain" />
</Frame>

Refer to the [White Label](/documentation/enterprise/whitelabel) documentation for more information on how to set up your white-labeled domain.

### 3. Copy the Share Link

Copy the share link to share the agent with others.

<Frame>
  <img alt="Share Agent Link" />
</Frame>


# Agent's Dashboard
Source: https://docs.droxy.ai/documentation/sharing/dashboard

Learn how to share your Droxy agent's dashboard

## Why Share Your Agent's Dashboard?

Droxy allows you to share an individual agent's dashboard with others. This dashboard provides access to the agent's configuration details, conversations, leads, evaluations, and more.
You can share an agent's dashboard with your team, clients, or the public. The sharing feature lets you distribute access to a specific agent's dashboard through a simple shareable link. Once shared, users can view the agent's analytics, leads, evaluations, and other dashboard features.
You can also revoke or modify dashboard access at any time through the sharing settings.

## How to Share Your Agent's Dashboard?

### 1. Open the Sharing Settings

Open the sharing settings by clicking on the **Share** button on the agent's dropdown menu.

<Frame>
  <img alt="Share Button" />
</Frame>

### 2. Select the Sharing Configuration

Select the sharing configuration you want to use.

#### 2.1 Select the Accessibility

Select the accessibility of the agent.

<Frame>
  <img alt="Share Accessibility" />
</Frame>

* **Public**: Make the agent accessible to everyone.
* **Private**: Make the agent accessible to everyone but protected with a password.
* **Protected**: Make the agent accessible only to you.

#### 2.2 Select Your White-Label Domain

If you want your agent to have a white-labeled domain when sharing the agent with others (e.g., `https://agent.example.com`), you can set it up here.

<Frame>
  <img alt="Share White-Label Domain" />
</Frame>

Refer to the [White Label](/documentation/enterprise/whitelabel) documentation for more information on how to set up your white-labeled domain.

#### 2.3 Enable the Dashboard Access

Enable the dashboard access by clicking on the switch.

<Frame>
  <img alt="Share Enable Dashboard Access" />
</Frame>

#### 2.4 Select the Dashboard Link

Select the dashboard link by clicking on the **Dashboard** button.

<Frame>
  <img alt="Share Dashboard Toggle Link" />
</Frame>

### 3. Copy the Dashboard Link

Copy the dashboard link to share the agent's dashboard with others.

<Frame>
  <img alt="Share Dashboard Link" />
</Frame>


# Subscription
Source: https://docs.droxy.ai/documentation/subscription

Learn how to manage your subscription and billing.

## Update Your Payment Method

You can easily update your payment method in Droxy through our secure and straightforward process using Stripe as our payment processor.

## Step-by-Step Guide

### 1. Access Billing Settings

Navigate to the **Settings** section from the left sidebar and click on the **Billing** tab to view your subscription details.

<Frame>
  <img alt="Settings Navigation" />
</Frame>

### 2. Update Subscription

From the billing page, click the **Update subscription** button to proceed with payment method changes.

<Frame>
  <img alt="Billing Page" />
</Frame>

### 3. Add New Payment Method

<Frame>
  <img alt="Add Payment Method Form" />
</Frame>

### 4. Enter card information and set as default

Enter your credit card information and check the "Use as default payment method" box if you want this card to be your primary payment method for future billing cycles.

<Frame>
  <img alt="Set Default Payment" />
</Frame>

Click **Add** to save your new payment method.

## Important Notes

* All payments are securely processed through Stripe
* You can maintain multiple payment methods
* Your subscription will automatically use your default payment method
* Changes take effect immediately


# Usage and Limits
Source: https://docs.droxy.ai/documentation/usage

Understanding token usage, voice minutes, and other limits in Droxy

## What is a token?

A token is a unit of computation used by LLMs (Large Language Models). When an LLM generates a response, it consumes a certain number of tokens. When an LLM is used to embed knowledge items, it also consumes a certain number of tokens. Here's a rough estimate of what one token is equivalent to:

* An LLM token typically represents about 4 characters or 3/4 of an average English word.
* As a rough estimate, 1 word ≈ 1.33 tokens.
* Those estimates are for English text. For other languages, the token to word ratio is usually higher.

### Knowledge Tokens

Knowledge tokens are consumed when you upload new knowledge items to Droxy.

For example, if you upload a company guidelines PDF with 10,000 words, it would use approximately 15,000 knowledge tokens.

* Tokens are counted per uploaded knowledge item.
* There are no limits to the number of knowledge items you can upload.
* Deleting a knowledge item will not reduce your token usage.
* Tokens are reset every month.

### Message Tokens

Message tokens are used whenever a text-based agent (website, WhatsApp, etc.) generates a response to a user query.

* Tokens are counted for both the prompt and the response.
* Tokens are updated after every message.
* Tokens are reset every month.

## Phone Agent Usage

For phone-based agents, we track usage differently:

* Usage is measured in active call seconds, counting the entire duration of the call with the agent from start to finish.
* Usage is updated after every call.

### Phone Numbers

* All paid tiers include one free phone number that you can attach to your voice agent.
* Additional phone numbers can be imported from your Twilio account up to your plan's limits.

## Other Usage Limits

### Transcription Minutes

For MP4 knowledge items, we track the number of transcription minutes. This corresponds directly to the length of the video file.

### Storage

We monitor the storage used by all knowledge items uploaded to your account. That storage usage is reset after every upload or deletion of a knowledge item.

## Increasing Limits

If you need higher limits that are not available on any of our existing plans, please contact us at [contact@droxy.ai](mailto:contact@droxy.ai). We're happy to work with you to find a custom solution that fits your specific needs.

## Monitoring Your Usage

To keep track of your usage and ensure you're within your plan's limits:

1. Log in to your [Droxy dashboard](https://app.droxy.ai).
2. Navigate to **Settings** and then **Usage**.
3. Here, you'll find detailed breakdowns of your token usage, voice minutes, storage, and other relevant metrics.

On paid plans, we will also send you an email if you're approaching your limits.

## What happens when I hit my limits?

When you reach a usage limit, the feature associated with that limit will no longer work and you'll receive a notification. Here's what happens for each type of limit:

* **Message Generation**: When you hit the generated tokens limit, your agents will not be able to respond to messages
* **Knowledge Base**: When you reach the knowledge tokens limit, you will not be able to upload more knowledge items
* **Voice Calls**: When you hit the call minutes limit, you will not be able to start new calls

In all cases, you can easily upgrade your plan to increase the limits. If you don't see limits that are suitable for your business, reach out directly to us at [contact@droxy.ai](mailto:contact@droxy.ai)