Skip to main content

Machine learning based dialogue engine for conversational software.

Project description

Rasa Python-SDK

Join the chat on Rasa Community Forum Build Status PyPI version Documentation Status

Python SDK for the development of custom actions for Rasa.


To install the SDK run

pip install rasa-sdk


rasa-sdk package:

SDK version compatible Rasa version
1.0.x >=1.0.x

old rasa_core_sdk package:

SDK version compatible Rasa Core version
0.12.x >=0.12.x
0.11.x 0.11.x
not compatible <=0.10.x


Detailed instructions can be found in the Rasa Documentation about Custom Actions.



In order to start an action server using implemented custom actions, you can use the available Docker image rasa/rasa-sdk:latest.

Before starting the action server ensure that the folder containing your actions is handled as Python module and therefore has to contain a file called

Then start the action server using:

docker run -p 5055:5055 --mount type=bind,source=<ABSOLUTE_PATH_TO_YOUR_ACTIONS>,target=/app/actions \

The action server is then available at http://localhost:5055/webhook.

Custom Dependencies

To add custom dependencies you enhance the given Docker image, e.g.:

FROM rasa/rasa-sdk:latest

# To install system dependencies
RUN apt-get update -qq && \
    apt-get install -y <NAME_OF_REQUIRED_PACKAGE> && \
    apt-get clean && \
    rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*

# To install packages from PyPI
RUN pip install --no-cache-dir <A_REQUIRED_PACKAGE_ON_PYPI>

Code Style

To ensure a standardized code style we use the formatter black. If your code is not formatted properly, travis will fail to build.

If you want to automatically format your code on every commit, you can use pre-commit. Just install it via pip install pre-commit and execute pre-commit install.

If you want to set it up manually, install black via pip install black. To reformat files execute

black .


Licensed under the Apache License, Version 2.0. Copyright 2019 Rasa Technologies GmbH. Copy of the license.

A list of the Licenses of the dependencies of the project can be found at the bottom of the Libraries Summary.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for rasa-sdk, version 1.0.0rc3
Filename, size File type Python version Upload date Hashes
Filename, size rasa_sdk-1.0.0rc3-py2.py3-none-any.whl (21.9 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size rasa-sdk-1.0.0rc3.tar.gz (20.3 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page