​
API Reference

Welcome to the synth-ai API reference. This documentation is automatically generated from the source code and provides comprehensive coverage of all public classes and functions.

​
Core Modules

​
Language Models

The synth_ai.lm module provides unified interfaces for working with various language model providers.
  • LM Class: Main interface for language model interactions
  • Vendor Support: OpenAI, Anthropic, Gemini, and more
  • Caching: Built-in request/response caching
  • Structured Outputs: Type-safe response parsing

​
Tracing

The synth_ai.tracing_v3 module offers comprehensive tracing and logging capabilities.
  • SessionTracer: Track AI interactions and system events
  • Event Management: Structured logging of LM calls and responses
  • Storage Backends: Support for SQLite, Turso, and other databases

​
Environments

The synth_ai.environments module provides frameworks for AI agent environments.
  • Stateful Environments: Persistent state management
  • Task Management: Define and execute AI tasks
  • Reproducibility: Deterministic environment execution

​
Auto-Generated Documentation

Detailed API documentation has been generated for:
  • Language Model Core: synth_ai_lm_core_main_v3_lm.mdx - Main LM class
  • Session Tracer: synth_ai_tracing_v3_session_tracer_sessiontracer.mdx - Core tracing
  • Stateful Environments: synth_ai_environments_stateful_core_statefulenvironment.mdx - Environment framework
Browse the documentation using the sidebar or search for specific classes and functions.

​
Source Code

This documentation is generated from the synth-ai repository. View the source code on GitHub.