> For the complete documentation index, see [llms.txt](https://karini-ai.gitbook.io/karini-ai-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://karini-ai.gitbook.io/karini-ai-documentation/recipes/workflow-recipe/create-copilot.md).

# Create copilot

Once you have created, published, and tested a workflow recipe, the subsequent action is to export it for deploying [Copilots](/karini-ai-documentation/copilots.md). 

#### Creating a Copilot

You can open the **Create Copilot** page for a recipe in either of the following ways:

* Select **Create Copilot** from the **Actions** menu associated with the recipe.
* Select **Create Copilot** from the **Actions** menu within the **Recipe Editor**.

#### Steps to Create a Copilot

1. Open the recipe in the **Recipe Editor**.
2. Ensure that the recipe has been published and that at least one published version is available.
3. Click the **Actions** menu (three-dot menu) in the top bar.
4. Select **Create Copilot**.

The system then validates that the recipe contains the required components.

After successful validation, you are redirected to the **Copilot Configuration** page.

#### Copilot Configuration

You can fill out all necessary fields to customize your Copilot, with detailed explanations provided for each field below.

* **Copilot Name:** A name for your copilot.
* **Welcome Message:** A welcome message to greet users upon interaction with the Copilot.
* **Description:** Description outlining the Copilot's purpose and capabilities.
* **Logo URL:** The URL of the logo to be displayed alongside the Copilot for branding purposes.
* **Seed Questions:** A set of initial questions or prompts to kickstart interactions with users.
* **Error Message:** A message to be displayed in case of errors or misunderstandings during interaction.
* **Widget Settings:** Customize the appearance and behavior of the Copilot widget for seamless integration, including widget size.\\
* **Enable Positive Feedback:** Enable "thumbs up" or positive feedback for users on Copilot interactions.
* **Enable Negative Feedback:** Enable "thumbs down" or negative feedback for users on Copilot interactions.
* **Custom Feedbacks:** You have the option to enable capturing various types of feedback on the copilot. This includes: 
  * **5-stars:** Copilot users can rate the content with a 5-star rating.
  * **option**: You can configure options to capture feedback on Copilot interactions based your specific requirement. E.g. You may configure the options as "Inaccurate", "Vaguely accurate", "Accurate".  These predefined options are made available to the copilot users to provide feedback on Copilot interactions. 
  * **text feedback:** Copilot users can provide descriptive text feedback. 
  * **Correction:** Enabling this option will allow the copilot users to provide corrections or improvements to the copilot response. 
* **Unsafe User Input Message:** A message to be displayed when Copilot detects unsafe user input.
* **Toxic User Input Message:** A message to be shown when Copilot identifies toxic user input.
* **Toxic Output Message:** A message to handle toxic output generated by Copilot.
* **Greeting Default Response:** A default message to greet users when the user question is detected as a greeting.
* **Show traces:** Enabling this option will display the traces icon on Copilot and users can view the traces for the LLM invocations. 
* **Hide Copilot:** The Hide Copilot option allows administrators to restrict UI access to Copilot, while permitting authorized users access via a direct link. This ensures a streamlined interface and maintains administrative control over exports and settings.
* **Base Domain URL:** The base domain URL for the Copilot's web interface or integration.

### Accessing and Embedding a Copilot

After specifying the base domain URL, the platform generates the **snippet code** required to embed the copilot into a custom user application. Once the copilot configuration is saved, the **Internal Copilot URL** becomes available for direct access to the copilot.

#### Deployment Options

After a copilot is configured, the following deployment options are available:

**1. Internal Copilot URL**

The **Internal Copilot URL** provides a direct link to the copilot within your environment. This URL can be shared with internal users who have the required access permissions.

**2. Embeddable Snippet Code**

The **Embeddable Snippet Code** is a JavaScript integration snippet that can be added to an external website or custom application to render the copilot chat widget.

```
<script
  src="https://your-instance.karini.ai/chatbot-script.js"
  data-id="karini_chatbot"
  data-bot_name="Your Bot Name"
  data-bot_avatar="https://your-avatar-url.png"
  data-description="Your bot description"
  data-welcome_message="Welcome! How can I help?"
  data-failure_message="Sorry, please try again."
  data-apikey="KARINI_..."
  data-widget_size="normal"
  data-theme_color="#7c3aed"
  defer
></script>
```

The snippet is automatically generated based on the copilot configuration defined during setup. It can be copied directly from the copilot configuration page and integrated into the target application without additional manual scripting.