Kolena Agents

Python client for interacting with Kolena Agents.

Initialization

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

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

export KOLENA_API_KEY="your-api-key"

Usage

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

from kolena_agents import Client

client = Client()

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

# each entry may be a path, an open binary file object, bytes, or a (filename, bytes_or_file_object) tuple
with open("path/to/large_file", "rb") as f:
    streamed_run = client.agent_run.add(agent_id=1, files=[f])

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

# alternatively, list all agent runs
all_runs = client.agent_run.list(agent_id=1)

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

# list all agents
all_agents = client.agent.list()

# get an agent
agent = client.agent.get(agent_id=1)

# update Agent metadata
updated_agent = client.agent.update_metadata(
    agent_id=1,
    metadata={
        "environment": "production",
        "version": 2,
        "tags": ["nlp", "extraction"]
    }
)

Webhook

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

from kolena_agents import webhook

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

Supported Python Versions

Python versions 3.9 and later are supported.

Metadata

Release files for kolena-agents 0.16.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for kolena-agents 0.16.0
File	Size	Uploaded
kolena_agents-0.16.0.tar.gz	78.5 kB	Sep 15, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for kolena-agents 0.16.0
File	Interpreter	ABI	Platform	Reset
kolena_agents-0.16.0-py3-none-any.whl 165.5 kB Sep 15, 2026	Python 3	none	any	Details

Total release size: 244.0 kB

Release files / kolena_agents-0.16.0.tar.gz

Download URL	kolena_agents-0.16.0.tar.gz
Size	78.5 kB
Tags	Source
SHA-256 checksum How to use checksums	`e19d4054bf17314553dd2240312299c178630cda47bd6304dd02c2e31e407e85`
BLAKE2b-256 checksum How to use checksums	`106ce25c788b9d587ad3890d212a34bed8780409c5b8c0a4cc32ffcf29072187`
Upload date	Sep 15, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.13.13`

Release files / kolena_agents-0.16.0-py3-none-any.whl

Download URL	kolena_agents-0.16.0-py3-none-any.whl
Size	165.5 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`80d045ec7f743bc22528c8e33713b23c8f563b82afce482ae85ed94b8328bc30`
BLAKE2b-256 checksum How to use checksums	`bff6c9c641abe285da5cc2b719f392631495f754c3db172ed087eadb1986f8dc`
Upload date	Sep 15, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.13.13`