The HTTP API for Parol – the Esperanto speech robot.
make to create a build of the API.
dist/api to bring up the API server.
→ ./dist/api Parol API Usage: api --conf=<config-file-path>
The API requires a TOML configuration file via the
The config file must contain the following values:
# address:port combination to bind to bind = ":9000" # AWS access key aws-key = "..." # AWS access secret aws-secret = "..." # AWS region aws-region = "eu-west-3" # AWS bucket name to store audio files aws-bucket = "parol" # the maximum number of requests to accept in any 1 hour period (set to 0 for no max) max-hourly-requests = 300 # keys to bypass the daily request and character limits full-access-keys = ["abcd", "1234"] # specifies whether the API should run in local or production mode development = true
To host your own instance of the API, you must have a valid AWS user (specified by
aws-secret), which has access to both of these services.