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 (main in 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_dispatch with base_branch like 3.16.x if 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

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

Download files

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

Source Distribution

rasa_sdk-3.19.0.tar.gz (60.5 kB view details)

Uploaded Aug 20, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

rasa_sdk-3.19.0-py3-none-any.whl (69.3 kB view details)

Uploaded Aug 20, 2026 Python 3

File details

Details for the file rasa_sdk-3.19.0.tar.gz.

File metadata

Download URL: rasa_sdk-3.19.0.tar.gz
Upload date: Aug 20, 2026
Size: 60.5 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for rasa_sdk-3.19.0.tar.gz
Algorithm	Hash digest
SHA256	`2cf388d4b5ddb430e045293b92b0a412bd335976ab99e40370d8469dc2b306ec`
MD5	`c02a6bb20862360eebd4548241a6f94b`
BLAKE2b-256	`d88a9430917eec74cbb5de9a7861ac0b75150e66436ae94dd8d6805be84f961c`

See more details on using hashes here.

Provenance

The following attestation bundles were made for rasa_sdk-3.19.0.tar.gz:

Publisher: release-artifacts.yml on RasaHQ/rasa-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: rasa_sdk-3.19.0.tar.gz
- Subject digest: 2cf388d4b5ddb430e045293b92b0a412bd335976ab99e40370d8469dc2b306ec
- Sigstore transparency entry: 2533284636
- Sigstore integration time: Aug 20, 2026
Source repository:
- Permalink: RasaHQ/rasa-sdk@8fca085f588dbf35034f8259604d8008b6dfb19f
- Branch / Tag: refs/tags/3.19.0
- Owner: https://github.com/RasaHQ
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release-artifacts.yml@8fca085f588dbf35034f8259604d8008b6dfb19f
- Trigger Event: push