Rasa Python-SDK
Python SDK for the development of custom actions for Rasa.
💡 We're migrating issues to Jira 💡
Starting January 2023, issues for Rasa Open Source are located in this Jira board. You can browse issues without being logged in; if you want to create issues, you'll need to create a Jira account.
Installation
To install the SDK run
pip install rasa-sdk
Compatibility
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 |
Usage
Detailed instructions can be found in the Rasa Documentation about Custom Actions.
Docker
Usage
In order to start an action server using implemented custom actions,
you can use the available Docker image rasa/rasa-sdk.
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 __init__.py
Then start the action server using:
docker run -p 5055:5055 --mount type=bind,source=<ABSOLUTE_PATH_TO_YOUR_ACTIONS>,target=/app/actions \
rasa/rasa-sdk:<version>
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.:
# Extend the official Rasa SDK image
FROM rasa/rasa-sdk:<version>
# Change back to root user to install dependencies
USER root
# 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>
# Switch back to non-root to run code
USER 1001
Building from source
Rasa SDK uses Poetry for packaging and dependency management. If you want to build it from source, you have to install Poetry first. This is how it can be done:
curl -sSL https://install.python-poetry.org | python3 -
There are several other ways to install Poetry. Please, follow the official guide to see all possible options.
To install dependencies and rasa-sdk itself in editable mode execute
make install
Code Style
To ensure a standardized code style we use the formatter ruff. If your code is not formatted properly, GitHub CI 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.
To check and reformat files execute
make lint
Steps to release a new version
Releasing a new version is quite simple, as the packages are build and distributed by GitHub Actions.
Release steps:
- Switch to the branch you want to cut the release from (
mainin case of a major / minor, the current release branch for patch releases). - If this is a minor / major release: Make sure all fixes from currently supported minor versions have been merged from their respective release branches (e.g. 3.3.x) back into main.
- Run
make release - Create a PR against main or the release branch (e.g.
1.2.x) - If this is a minor release, a new release branch should be created
pointing to the same commit as the tag to allow for future patch releases,
e.g.
git checkout -b 1.2.x git push origin 1.2.x
Auto patch after Renovate (supported 3.N.x lines)
When a Renovate dependency PR is merged into a supported SDK release line (3.N.x, never main),
Auto Release Renovate prepares the next micro/patch
(via scripts/release.py) and opens a prepare-release-<version> PR against that same line.
Operator steps:
- Confirm the prepare PR appeared (Actions also supports manual
workflow_dispatchwithbase_branchlike3.16.xif you need to re-run). - Review CI, changelog, and version on the prepare PR.
- Approve and merge it yourself.
- Existing Release workflow tags on
prepare-release-*merge; publish continues as usual.
If an open prepare-release-* already targets that 3.N.x, further Renovate merges on the same line
do not open another competing prepare PR. Manual make release / Release workflow dispatch remains
available. Merges to main and non-Renovate merges on 3.N.x do not start this path.
License
Licensed under the Apache License, Version 2.0. Copyright 2021 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.
Release files for rasa-sdk 3.20.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| rasa_sdk-3.20.1.tar.gz | 60.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| rasa_sdk-3.20.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 130.4 kB
Release files / rasa_sdk-3.20.1.tar.gz
| Download URL | rasa_sdk-3.20.1.tar.gz |
|---|---|
| Size | 60.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e18db87026b1c1cf5c7c64627debf09cdf679c13ee173b0b4516b91f623cbb3e
|
|
BLAKE2b-256 checksum How to use checksums |
17777c590b3984ad805e6c73e908ad1562c1004d8772510331deb975d7036b78
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.13
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 24, 2026.
Transparency logRelease files / rasa_sdk-3.20.1-py3-none-any.whl
| Download URL | rasa_sdk-3.20.1-py3-none-any.whl |
|---|---|
| Size | 69.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b76edd8ff8087187e33ce87e3de1f4fb423098cf834ad1bfcd07fece5438f877
|
|
BLAKE2b-256 checksum How to use checksums |
5c36edbde7cc066fe7f3e65f6fac75f081f8b1518ffbba1a0df71580d4ef9593
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.13
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 24, 2026.
Transparency log
