​
Installation

To connect to your Kolena Agents using Python, install the restructured client from PyPI using any Python package manager such as pip or poetry:

pip install restructured

​
Initialization

An API Key is required to use the python client. Generate a key from your user profile within the web UI.

Copy the created key and store in a RESTRUCTURED_API_KEY environment variable:

export RESTRUCTURED_API_KEY="your-api-key"

​
Usage

Here’s an example of how to use the client to add, download and delete agent runs:

from restructured import Restructured

client = Restructured()

# add new agent run
new_run = client.agent_run.add(agent_id=1, files=["path/to/file1", "path/to/file2"])

# download agent run
run = client.agent_run.get(agent_id=1, run_id=2)

# delete agent run
client.agent_run.delete(agent_id=1, run_id=2)

​
Webhook

Kolena provides a helper function to handle signature verification and parsing. See Webhook Connection for more information.

from restructured import webhook

result = webhook.construct_event(request_body, secret, request_headers)

​
Supported Python Versions

Python versions 3.8 and later are supported.