Skip to main content

API Reference

This section provides detailed documentation for Tyler's core components and APIs. Each page covers a specific component's interface, methods, and usage patterns.

Core Components​

  1. Agent - The central component for managing conversations and executing tasks
  2. Thread - Manages conversation history and context
  3. Message - Handles individual interactions and content
  4. Attachment - Manages file attachments and content storage

Installation​

To use these components, install Tyler:

pip install tyler-agent

Basic Usage​

Here's a quick example of using the core components:

from tyler import Agent, Thread, Message

# Create an agent
agent = Agent(
    model_name="gpt-4.1",
    purpose="To help with tasks"
)

# Create a thread
thread = Thread()

# Add a message
message = Message(
    role="user",
    content="Hello!"
)
thread.add_message(message)

# Process the thread
processed_thread, new_messages = await agent.go(thread)

Component Relationships​

The components work together in the following way:

  • Agent processes threads and manages tools
  • Thread contains messages and maintains context
  • Message holds content and metadata

Type Definitions​

All components use TypeScript-style type definitions:

class Agent:
    """The main agent class."""
    model_name: str
    purpose: str
    tools: List[Tool]
    ...

class Thread:
    """Conversation thread class."""
    messages: List[Message]
    system_prompt: Optional[str]
    ...

class Message:
    """Individual message class."""
    role: str
    content: str
    name: Optional[str]
    ...

Error Handling​

All components use standard Python exceptions:

try:
    await agent.go(thread)
except AgentError as e:
    print(f"Agent error: {e}")
except ThreadError as e:
    print(f"Thread error: {e}")
except MessageError as e:
    print(f"Message error: {e}")

See Also​