Skip to content

Kelvin API Client (Python) Overview

The Kelvin SDK includes several specialized libraries but does not expose every feature available on the Kelvin Platform.

The Kelvin API Client (Python) provides a unified Python interface for accessing all platform endpoints through standard Python scripts.

Note

There is also a builtin KelvinApp method for accessing the Kelvin API endpoints.

You can read all the documentation on this method in the Develop Kelvin SmartApps™ page here.

Installation

The Kelvin API Client (Python) can be installed separately or with the full Kelvin SDK package.

Note

When you install the kelvin-sdk library, it will also install the kelvin-python-api-client for Python programming.

Install the API client library.

Install Kelvin API Client (Python)
1
pip install kelvin-python-api-client

Using API Client

You can call any API request using the standard login protocols using a normal user account.

Warning

It is strongly recommended that you use secrets to avoid exposing your credentials in your code.

You can read all about Kelivn secrets here.

Login Kelvin API Client (Python) using User Account
1
2
3
4
5
6
7
8
from kelvin.api.client import Client

# Login
client = Client(url="https://<url.kelvin.ai>", username="<your_username>")
client.login(password="<your_password>")

# Create Asset
response = client.asset.list_assets()