Python SDK - Cominty Docs

The Cominty Python SDK wraps the chat API: start a conversation with an agent, stream its progress, continue the thread, and manage threads. Everything is scoped to a single end user (user_id) that you set once on the client.

Quickstart

Task-by-task examples, each with runnable code on GitHub.

Reference

Every resource, model, event, and exception.

GitHub

Source, issues, and the full examples/ directory.

API reference

The HTTP endpoints the SDK calls, with a live playground.

Package cominty-sdk (PyPI) · import cominty_sdk · version 0.3.0 · Python 3.9+ · style async-only (httpx), fully typed.

Install

pip install cominty-sdk        # or: uv add cominty-sdk

Authenticate

You need two credentials, both from platform.cominty.ai:

Get your API key

Open the API keys page and create a key.

Get your user id

Open your avatar → Profile. It looks like user_31HPTBuBvX20xlQNAbvxjOxPbKB.

Export both

export COMINTY_API_KEY="<your API key>"
export COMINTY_USER_ID="user_..."

With both set, AsyncCominty() picks them up automatically — no arguments needed.

Pick an agent_id from platform.cominty.ai/agents (for example __cominty_agents::agent.chat).

Your first call

import asyncio
from cominty_sdk import AsyncCominty

async def main():
    async with AsyncCominty() as client:          # reads COMINTY_API_KEY + COMINTY_USER_ID
        run = await client.chat.start(
            agent_id="__cominty_agents::agent.chat",
            message="What is Cominty?",
        )
        print(await run.text())

asyncio.run(main())

Core concepts

Client — one user per client

AsyncCominty is bound to a single user_id, validated at construction and applied to every request. Resource methods never take user_id. Use it as an async context manager (async with) or call await client.close() when done. See Client for all settings.

Resources — chat and threads

client.chat starts and continues conversations and streams progress. client.threads lists, fetches, updates, and archives threads — all scoped to the client’s user. See Resources.

Runs — the assistant's in-progress reply

chat.start and chat.send return a run: the assistant’s reply as it is being produced. Iterate it for live progress events, or just await run.text() for the final answer. A run’s stream is single-use. See The run handle.

Tools — on by default

Web search, company-document retrieval, and any MCP servers connected to the agent are enabled automatically. You only ever turn things off, with disabled_tools. See disabled_tools.

Configuration

Setting	Argument	Env var	Default
API key	`api_token`	`COMINTY_API_KEY`	— (required)
End user	`user_id`	`COMINTY_USER_ID`	— (required)
Base URL	`base_url`	`COMINTY_BASE_URL`	`https://ds.cominty.com`
Timeout	`timeout`	—	`60` (seconds)

Resolution order is explicit argument → environment variable → default. The SDK does not auto-load .env files.

Quickstart

Reference

GitHub

API reference

​Install

​Authenticate

​Your first call

​Core concepts

​Configuration

Install

Authenticate

Your first call

Core concepts

Configuration