API Reference
Complete reference documentation for Synapse SDK classes and functions.
Overview
The Synapse SDK API is organized into the following main modules:
Clients
Client classes for interacting with backend services and agents.
- BackendClient - Main client for backend operations
- AgentClient - Client for agent-specific operations
- BaseClient - Base class for all clients
Core plugin system components.
Utilities
Helper functions and utilities.
- File Utils - File operations and handling
- Storage - Storage providers (S3, GCS, SFTP)
- Types - Custom types and fields
Quick Reference
Creating a Client
from synapse_sdk.clients.backend import BackendClient
client = BackendClient(
base_url="https://api.synapse.sh",
api_token="your-api-token"
)