Back to Suna

Kortix SDK

sdk/README.md

11.8 KB
Original Source

Kortix SDK

[!WARNING] This SDK is currently in early development and is NOT ready for production use.

The API is subject to breaking changes, features may be incomplete, and documentation may be outdated. Use at your own risk.

A Python SDK that enables you to create, manage, and interact with AI Workers on Kortix.

๐Ÿ“ฆ Installation

Install directly from the GitHub repository:

bash
pip install "kortix @ git+https://github.com/kortix-ai/suna.git@main#subdirectory=sdk"

Or using uv:

bash
uv add "kortix @ git+https://github.com/kortix-ai/suna.git@main#subdirectory=sdk"

๐Ÿ”ง Quick Start

python
import asyncio
from kortix import kortix

async def main():
    mcp_tools = kortix.MCPTools(
        "http://localhost:4000/mcp/",  # Point to any HTTP MCP server
        "Kortix",
    )
    await mcp_tools.initialize()

    # Initialize the client
    client = kortix.Kortix(api_key="your-api-key")

    # Create an agent
    agent = await client.Agent.create(
        name="My Assistant",
        system_prompt="You are a helpful AI assistant.",
        mcp_tools=[mcp_tools],
        allowed_tools=["get_wind_direction"],
    )

    # Create a conversation thread
    thread = await client.Thread.create()

    # Run the agent
    run = await agent.run("Hello, how are you?", thread)

    # Stream the response
    stream = await run.get_stream()
    async for chunk in stream:
        print(chunk, end="")

if __name__ == "__main__":
    asyncio.run(main())

๐Ÿ”‘ Environment Setup

Get your API key from https://www.kortix.com/settings/api-keys

๐Ÿงช Running Examples

bash
# Install dependencies
uv sync

# Run the main example
PYTHONPATH=$(pwd) uv run example/example.py