Getting Started

This section will guide you through the process of installing and configuring the Digital Employee Core package, and help you build your first digital employee.

Overview

The Getting Started section covers:

1. Installation — Install the Digital Employee Core package

2. Configuration — Set up required environment variables

3. Examples — Build your first digital employee

Prerequisites

Before installing the Digital Employee Core package, ensure you have completed all the Prerequisites:

• Installed a Python IDE (PyCharm or VSCode)

• Installed Python 3.12

• Installed uv package manager

Installation

Quick Install

If you already have the prerequisites installed, quickly install the package:

uv add digital-employee-core

Verify Installation

You can verify the installation by checking the package version:

uv pip show digital-employee-core

You can check the PyPI resource: Digital Employee Core PyPI.

Configuration

After installation, you need to configure the environment variables for the Digital Employee Core to function properly.

1. Create Environment File

Copy the example environment file and add your credentials:

cp .env.example .env

2. Add Required Configuration

Edit .env with your configuration:

# Required
OPENAI_API_KEY=your-api-key

3. Obtain API Credentials

To get the OPENAI_API_KEY values, contact Squad 4 (Claudia) team:

• Email: [e-mail]

The OPENAI_API_KEY is required for the Digital Employee Core to communicate with language models.

Additional Configuration for MCP Integration

If you plan to use MCP (Model Context Protocol) integrations like Google Mail, you'll need additional environment variables:

# For Google Mail MCP integration
GOOGLE_MAIL_MCP_URL=https://connectors.gdplabs.id/google_mail/mcp
GOOGLE_MCP_X_API_KEY=<your-x-api-key>

To obtain the GOOGLE_MCP_X_API_KEY:

1. Open https://connectors.gdplabs.id/console, then sign in.

2. In the Credentials section, expand the x-api-key panel and click Copy combined value button.

3. Under Available Modules section, find the Google_mail integration and click Add New Integration button.

4. An authorization URL will appear. Click or copy the URL, then authenticate using your Gmail account.

Next Steps

Now that you have installed and configured the Digital Employee Core:

• Examples — Build your first digital employee

• Introduction — Understand how the system works

• Guides — Advanced configurations

Need Help?

If you encounter any issues during installation or setup, please contact the Squad 4 (Claudia) team:

• Email: [e-mail]