Skip to main content
To run evaluation jobs through the Vijil Evalute API and interact with the results, you need to install the client library that provides the necessary functionalities. You can do so through downloading the library from PyPI.
Shell
pip install -U vijil
To ensure you are using the latest version of the package, we recommend using the -U or --upgrade option.

​
Authentication using API Keys

You need a Vijil API key to authenticate remotely through the client library. You can obtain the API key by logging into your Vijil account, going to the profile page on the dashboard, then copying the value in the Token field. API Token Location | 80% After your obtain an API key, you can export it in the environment you intend to use the client inside.
Shell
export VIJIL_API_KEY = <eyj-xxxx>
Alternatively, you can store the key in a .env file and load it into your Python environment using a library such as python-dotenv. This user token expires after 24 hours. If you plan to use the API over long periods of time, you should use machine-to-machine secrets to regularly refresh the token.