notice

This is unreleased documentation for Rasa Action Server Documentation Master/Unreleased version.
For the latest released documentation, see the latest version (2.0.0).

Version: Master/Unreleased

Running a Rasa SDK Action Server

There are two ways to run the action server, depending on whether you are using an environment with rasa installed or not:

If rasa is installed, you can run the action server using a rasa command:

rasa run actions

If rasa is not installed, you can run the action server directly as a python module:

python -m rasa_sdk --actions actions

Using the command above, rasa_sdk will expect to find your actions in a file called actions.py or in a package directory called actions. You can specify a different actions module or package with the --actions flag.

The full list of options for running the action server with either command is:

usage: __main__.py [-h] [-p PORT] [--cors [CORS [CORS ...]]]
[--actions ACTIONS] [--ssl-keyfile SSL_KEYFILE]
[--ssl-certificate SSL_CERTIFICATE]
[--ssl-password SSL_PASSWORD] [--auto-reload] [-v] [-vv]
[--quiet]
starts the action endpoint
optional arguments:
-h, --help show this help message and exit
-p PORT, --port PORT port to run the server at
--cors [CORS [CORS ...]]
enable CORS for the passed origin. Use * to whitelist
all origins
--actions ACTIONS name of action package to be loaded
--ssl-keyfile SSL_KEYFILE
Set the SSL certificate to create a TLS secured
server.
--ssl-certificate SSL_CERTIFICATE
Set the SSL certificate to create a TLS secured
server.
--ssl-password SSL_PASSWORD
If your ssl-keyfile is protected by a password, you
can specify it using this paramer.
--auto-reload Enable auto-reloading of modules containing Action
subclasses.
-v, --verbose Be verbose. Sets logging level to INFO
-vv, --debug Print lots of debugging statements. Sets logging level
to DEBUG
--quiet Be quiet! Sets logging level to WARNING