---
name: "apertium-apy"
section: "1"
platform: "linux"
package: "apertium-apy"
version: "0.13.0-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/apertium-apy"
---

# apertium-apy(1)

API server for machine translation and language analysis.

## NAME

apertium-apy - API server for machine translation and language analysis.

## SYNOPSIS

**apertium-apy** \[ **pairs\_path** \] path to Apertium installed pairs (all modes files in this path are included).

## OPTIONS

- **-h**, **--help**

  Show this help message and exit.

- **-s** *NONPAIRS\_PATH*, **--nonpairs-path** *NONPAIRS\_PATH*

  Path to Apertium tree (only non-translator debug modes are included from this path).

- **-l** *LANG\_NAMES*, **--lang-names** *LANG\_NAMES*

  Path to localised language names sqlite database (default = langNames.db)

- **-f** *MISSING\_FREQS*, **--missing-freqs** *MISSING\_FREQS*

  Path to missing word frequency sqlite database (default = None)

- **-p** *PORT*, **--port** *PORT*

  Port to run server on (default = 2737)

- **-c** *SSL\_CERT*, **--ssl-cert** *SSL\_CERT*

  Path to SSL Certificate

- **-k** *SSL\_KEY*, **--ssl-key** *SSL\_KEY*

  Path to SSL Key File

- **-t** *TIMEOUT*, **--timeout** *TIMEOUT*

  Timeout for requests (default = 10)

- **-j** *NUM\_PROCESSES*, **--num-processes** *NUM\_PROCESSES*

  Number of processes to run (default = 1; use 0 to run one http server per core, where each http server runs all available language pairs)

- **-d**, **--daemon**

  Daemon mode: redirects stdout and stderr to files apertium-apy.log and apertium-apy.err; use with **--log-path**

- **-P** *LOG\_PATH*, **--log-path** *LOG\_PATH*

  Path to log output files to in daemon mode; defaults to local directory

- **-i** *MAX\_PIPES\_PER\_PAIR*, **--max-pipes-per-pair** *MAX\_PIPES\_PER\_PAIR*

  How many pipelines we can spin up per language pair (default = 1)

- **-n** *MIN\_PIPES\_PER\_PAIR*, **--min-pipes-per-pair** *MIN\_PIPES\_PER\_PAIR*

  When shutting down pipelines, keep at least this many open per language pair (default = 0)

- **-u** *MAX\_USERS\_PER\_PIPE*, **--max-users-per-pipe** *MAX\_USERS\_PER\_PIPE*

  How many concurrent requests per pipeline before we consider spinning up a new one (default = 5)

- **-m** *MAX\_IDLE\_SECS*, **--max-idle-secs** *MAX\_IDLE\_SECS*

  If specified, shut down pipelines that have not been used in this many seconds

- **-r** *RESTART\_PIPE\_AFTER*, **--restart-pipe-after** *RESTART\_PIPE\_AFTER*

  Restart a pipeline if it has had this many requests (default = 1000)

- **-v** *VERBOSITY*, **--verbosity** *VERBOSITY*

  Logging verbosity.

- **-V**, **--version**

  Show APY version and exit.

- **-S**, **--scalemt-logs**

  Generates ScaleMT-like logs; use with **--log-path**; disables

- **-M** *UNKNOWN\_MEMORY\_LIMIT*, **--unknown-memory-limit** *UNKNOWN\_MEMORY\_LIMIT*

  Keeps unknown words in memory until a limit is reached; use with --missing-freqs (default = 1000)

- **-T** *STAT\_PERIOD\_MAX\_AGE*, **--stat-period-max-age** *STAT\_PERIOD\_MAX\_AGE*

  How many seconds back to keep track request timing stats (default = 3600)

- **-wp** *WIKI\_PASSWORD*, **--wiki-password** *WIKI\_PASSWORD*

  Apertium Wiki account password for SuggestionHandler

- **-wu** *WIKI\_USERNAME*, **--wiki-username** *WIKI\_USERNAME*

  Apertium Wiki account username for SuggestionHandler

- **-b**, **--bypass-token**

  ReCAPTCHA bypass token

- **-rs** *RECAPTCHA\_SECRET*, **--recaptcha-secret** *RECAPTCHA\_SECRET*

  ReCAPTCHA secret for suggestion validation.

- **-md** *MAX\_DOC\_PIPES*, **--max-doc-pipes** *MAX\_DOC\_PIPES*

  How many concurrent document translation pipelines we allow (default = 3)

- **-C** *CONFIG*, **--config** *CONFIG*

  Configuration file to load options from.

- **-ak** *API\_KEYS*, **--api-keys** *API\_KEYS*

  Configuration file to load API keys.

## Homepage

\<https://github.com/apertium/apertium-apy\>