Rossum Developer Hub

Rossum Data Capture for Developers and Integrators

Welcome to the Rossum developer hub. You'll find comprehensive guides and documentation to help you implement Rossum as quickly as possible, as well as support if you get stuck.

Let's jump right in!

Developer Guides    API Reference    User Help Center    Feature wishlist

Setting up rossum tool

To have an advanced access to the configuration of your account, you will want to use our command-line configuration tool rossum.

Installing rossum


On Windows, rossum is simply installed like any other standalone application. Download the latest rossum version and go through the installation wizard. You can then launch it either from the Start menu, or from the command prompt.


On Mac, rossum is installed as a Python script.

We will be working from a Mac terminal shell window. First, make sure you have Python3 installed. Next, install the tool itself by

pip install rossum

and run it simply by typing


in the terminal shell.


On Linux, rossum is installed as a Python script too, in a terminal shell window. Make sure you have at least Python 3.6 installed on your system. The tool itself is installed by either

pip install rossum


pip3 install rossum

depending on your Linux distribution. To run it, simply type


in the terminal shell.

Configuring rossum

The rossum tool is using standard Rossum APIs and needs to authenticate towards them. To get everything set up, type in the configure command on first run. Go with the default API endpoint if asked, but then type in the same username and password that you use to log into Rossum. The credentials will be saved on your computer for next invocations of the tool.

In the rest of our guide, we will mostly be showing just specific examples of the tool, but you will find extra tips & tricks about on the rossum GitHub page.

Updated about a year ago

Setting up rossum tool

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.