katonic-sdk
The Python SDK for the Katonic 7.0 platform: the public API client
(KatonicClient), agent authoring, blueprint scaffolding, multi-agent
composition, and local evaluation.
pip install "katonic-sdk>=7"
# or pin it to the version of the platform you deploy (X.Y.Z):
pip install "katonic-sdk==X.Y.Z"
Sovereign / air-gapped installs: download the wheel from your deployment's Developer Hub instead.
Quickstart
export KATONIC_BASE_URL=https://<your-studio-host> # the host; the client adds /public/v1
export KATONIC_API_KEY=kapi_... # Studio > Public API > API keys
import asyncio
from katonic import KatonicClient
async def main():
async with KatonicClient() as k: # reads KATONIC_API_KEY / KATONIC_BASE_URL
agent = (await k.list_agents())[0] # published agents; chat takes the agent's id
resp = await k.chat(agent.id, "What is the PTO policy?")
print(resp.message.content)
asyncio.run(main())
The katonic command ships with the package (katonic login,
katonic agents list, katonic search … — see katonic --help).
What the client covers
KatonicClient wraps the platform's public API, one async method per call:
| Area | Methods |
|---|---|
| Agents | list_agents, get_agent, create_agent, update_agent, publish_agent |
| Chat and sessions | chat, chat_stream, create_session, list_sessions, get_history, delete_session, submit_feedback |
| Models | list_models, get_model, completions (OpenAI-compatible) |
| Knowledge | list_sources, create_source, upload_documents, ingest, sync_source, search |
| Knowledge graph | load_graph, get_graph_schema, query_graph |
| Graph schemas | list_ontologies, create_ontology, get_ontology, update_ontology, publish_ontology, new_ontology_version, delete_ontology, validate_ontology, discover_ontology, list_source_ontologies, attach_ontology, detach_ontology, set_ontology_mode, baseline_ontology_violations |
| Evaluation | list_datasets, upload_dataset, run_evaluation, get_evaluation, poll_evaluation, compare_evaluations |
| Prompt optimization | optimize_prompt, get_optimization, poll_optimization |
| Data flywheel | ingest_traces, get_quality_trend, build_flywheel_dataset |
| Skills | list_skills, get_skill, import_skills |
| Tools | list_tools, execute_tool |
| Guardrails | evaluate_guardrails |
| Usage and cost | get_usage, get_analytics_usage, get_cost_breakdown |
Each call needs the matching scope on the key. A few are refused by the platform whatever the key holds, while the public API does not yet allow them: creating knowledge sources, uploading documents, and creating, changing, validating or deleting graph schemas.
The rest of the package authors agents offline, with no platform:
katonic.gateway,katonic.knowledge,katonic.guardrailsandkatonic.toolsbuild an agent's bindings;katonic.composewires sub-agents into NAT workflows;katonic.scaffoldwrites blueprint packages;katonic.evaluatewrites local evaluation configs;katonic.connectorsis the base class for custom knowledge connectors.
Naming, versioning, and one caveat
- Distribution name:
katonic-sdk, from 7.x (this package). The 6.x releases under the same name are Katonic's legacy MLOps SDK, a different API: pinkatonic-sdk<7if you still need it. Earlier 7.x documentation called this packagekatonic-platform; it was never published under that name. - Import name:
import katonic. The legacykatonic6.2.0 package owns the same import name — installing both in one environment is a silent module collision. Keep them in separate environments. - Versioning: the SDK is released with the platform, at the platform's
version: platform
vX.Y.Ziskatonic-sdk==X.Y.Z. Development builds,X.Y.Z.devN, are published to TestPyPI only. Install the version that matches your deployment. A newer SDK can call routes that an older platform does not have.
Support
Issues and questions go through your Katonic support channel; the API reference lives in your deployment's Developer Hub.
Metadata
Release files for katonic-sdk 7.0.18
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| katonic_sdk-7.0.18-py3-none-any.whl | Python 3 | none | any | Details |
Release files / katonic_sdk-7.0.18-py3-none-any.whl
| Download URL | katonic_sdk-7.0.18-py3-none-any.whl |
|---|---|
| Size | 58.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d095c9682e403863c4d78cf7e7c8657560f22d113fcd3aff8fad0f46f9a4998a
|
|
BLAKE2b-256 checksum How to use checksums |
b26959a83d32842725413cd9aaed7bc8a88138d4871d1feb43f6e143750bba7a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|