Skip to content

Download

Teamwire SDK is available as zip package:

Installation

After extracting the Teamwire_SDK_v2.0.0.zip package, you will get the following directory structure:

Teamwire_SDK_v2.0.0
├── API-TermsOfService.pdf
├── CHANGELOG.md
├── example_bots
│   ├── echo.py
│   ├── greeting.py
│   ├── managechat.py
│   └── README.md
├── examples
│   ├── attention_messages.py
│   ├── avatar.py
│   ├── bot_info.py
│   ├── bot_profile.py
│   ├── create_chat.py
│   ├── event_echo_bot.py
│   ├── live_location.py
│   ├── manage_chat.py
│   ├── message_logger.py
│   ├── profiles.py
│   ├── README.md
│   ├── requirements.txt
│   └── roles
│       ├── chat_roles.py
│       ├── directory_roles.py
│       ├── README.md
│       └── role_notifications.py
└── sdk
    ├── python-3.11
    │   ├── install.txt
    │   └── teamwire_api-2.0.0-py311-none-any.whl
    ├── python-3.12
    │   ├── install.txt
    │   └── teamwire_api-2.0.0-py312-none-any.whl
    └── python-3.13
        ├── install.txt
        └── teamwire_api-2.0.0-py313-none-any.whl

To install the Teamwire SDK module for your chosen Python environment (Python 3.11, 3.12 or 3.13), follow these steps:

  1. Go to the sdk/python-3.X directory of your choice. For example:

    $ cd Teamwire_SDK_v2.0.0/sdk/python-3.13

  2. Install the Python package by running:

    pip install teamwire_api-2.0.0-py313-none-any.whl

This will install all dependencies and make the teamwire_api module available in your Python setup.

Feel free to check out the example bots and scripts contained in the example_bots and examples directories for a detailed view of how the SDK can be used to create chatbots and third-party integrations.

Teamwire SDK Docker image

The Teamwire SDK is available on Teamwire's Harbor Registry as a base Docker image you can use to create your own bot images.

Please refer to the Running a bot with Docker section to learn how to create a custom Docker image for your Teamwire bots.

Harbor access

Contact our support team to get access to Teamwire Harbor repositories.