Skip to main content

Kimss Python SDK for conversational AI agents

Project description

Kimss Python SDK

Lightweight client for the Kimss API. Use it to call your Kimss agents from Python scripts, backends, or notebooks.

Install

pip install kimss

Or from this repo (editable):

cd kimss_sdk && pip install -e .

Authentication

Use a long-lived API key (not a browser session token). Create keys in your Kimss app under Developer Settings → API Keys. The key is scoped to your tenant and user.

Usage

from kimss import KimssClient, Agent

client = KimssClient(
    api_key="kimss_xxxxxxxxxxxxxxxxxxxxxxxx",  # from Developer Settings
    base_url="https://api.kimss.ai",          # or your deployment URL
)

# Get an agent and send a message
agent = client.get_agent(agent_id="asst_xxxx")
result = agent.query("Hello")
# result is the API "res" payload (run_id, thread_id, messages, usage, etc.)

# Continue a thread
result2 = agent.query("What did I just say?", thread_id=result.get("thread_id"))

# Or use the client directly
result3 = client.chat(assistant_id="asst_xxxx", message="Hi", thread_id=result.get("thread_id"))

API

  • KimssClient(api_key, base_url="https://api.kimss.ai") – authenticated client.
  • client.get_agent(agent_id) – returns an Agent for that assistant.
  • agent.query(message, thread_id=None, chat_type="user_chat") – send a message; returns the res object from POST /assistant_chat/.
  • client.chat(assistant_id, message, thread_id=None, chat_type="user_chat") – one-off chat without an Agent handle.

All requests use the X-Kimss-Key header. No streaming in this version; responses are full JSON.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kimss-0.1.0.tar.gz (2.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kimss-0.1.0-py3-none-any.whl (3.2 kB view details)

Uploaded Python 3

File details

Details for the file kimss-0.1.0.tar.gz.

File metadata

  • Download URL: kimss-0.1.0.tar.gz
  • Upload date:
  • Size: 2.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.0

File hashes

Hashes for kimss-0.1.0.tar.gz
Algorithm Hash digest
SHA256 e598a8c2e58f373818d50c81e0df80f450b7dff0886203e2ba90eb42e203f7f8
MD5 9164d656b1872d14b3d738d12d89295f
BLAKE2b-256 ac0fc4bc9cd7ceaca3205c50f008ee919452c659df99d4f23049d9ba770e3252

See more details on using hashes here.

File details

Details for the file kimss-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: kimss-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 3.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.0

File hashes

Hashes for kimss-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b73a07cea3cfe12dcefdf5ff8cc73075eb299902f0457431d4af10219d7de52d
MD5 8a1ac3fe4878391edc00c02ed597d620
BLAKE2b-256 3ab2435c4e27d3d28ddd2856f120683c62b33097a485cd7abed80dd25d73e1f4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page