AugmentOS SDK Reference

Welcome to the reference for the AugmentOS SDK. This section provides detailed information about all classes, interfaces, types, and enums available in the @augmentos/sdk package.

Overview

The AugmentOS SDK is organized into several main components:

• Primary Classes: Core classes like TpaServer and TpaSession that serve as the main entry points for TPA development
• Manager Classes: Component classes like EventManager and LayoutManager that handle specific functionalities
• Authentication: Features for user authentication like Webview Authentication for in-app webviews
• Enums: Enumeration types that define constants and options throughout the SDK
• Interfaces: Type definitions for configuration objects, events, layouts, and messages
• Utilities: Helper functions and utility classes

How to Use This Reference

This reference is organized by component category. If you're looking for:

• How to create a TPA server, see the TpaServer
• Event handling functionality, see the EventManager
• UI display capabilities, see the LayoutManager
• User authentication in webviews, see the Webview Authentication
• Available event types, see the Event Types
• Layout options, see the Layout Types
• Configuration interfaces, see the Config Types
• Webhook interfaces, see the Webhook Types
• Message interfaces, see the Message Types
• Token utilities, see the Token Utilities
• Resource management and utility functions, see the Utilities

For practical implementation examples, refer to our Quickstart Guide and Core Concepts sections.