Synodes Documentation
The Synodes SDK provides official Python and TypeScript interfaces for interacting with Synodes, enabling you to programmatically manage development environments and execute code.
Quick Start
Run your first line of code in a Synodes Sandbox. Use our LLMs context files for faster development with AI assistants.
1. Get Your API Key
- Go to the Synodes Dashboard.
- Create a new API key. Make sure to save it securely, as it won’t be shown again.
2. Install the SDK
pip install synodesnpm install @synodesio/sdk3. Write Your Code
Create a file named: main.py
from synodes import Synodes, SynodesConfig
# Define the configuration
config = SynodesConfig(api_key="your-api-key")
# Initialize the Synodes client
synodes = Synodes(config)
# Create the Sandbox instance
sandbox = synodes.create()
# Run the code securely inside the Sandbox
response = sandbox.process.code_run('print("Hello World from code!")')if response.exit_code != 0: print(f"Error: {response.exit_code} {response.result}")else: print(response.result)
# Clean up
sandbox.delete()Create a file named: index.mts
import { Synodes } from '@synodesio/sdk';
// Initialize the Synodes clientconst synodes = new Synodes({ apiKey: 'your-api-key' });
// Create the Sandbox instanceconst sandbox = await synodes.create({ language: 'typescript',});
// Run the code securely inside the Sandboxconst response = await sandbox.process.codeRun('console.log("Hello World from code!")')console.log(response.result);
// Clean upawait sandbox.delete()4. Run It
python main.pynpx tsx index.mts✅ What You Just Did
- Installed the Synodes SDK.
- Created a secure sandbox environment.
- Executed code remotely inside that sandbox.
- Retrieved and displayed the output locally.
You’re now ready to use Synodes for secure, isolated code execution.
Introduction
- Getting Started
Learn about Synodes SDK and how it can help you manage your development environments. - Configuration
Get started with Synodes SDK and learn how to use and configure your development environments. - Sandboxes
Learn how to create, manage, and remove Sandboxes using the Synodes SDK. - Snapshots
Learn how to create, manage and remove Snapshots using the Synodes SDK. - Declarative Builder
Learn how to dynamically build Snapshots from Docker/OCI compatible images using the Synodes SDK. - Volumes
Learn how to manage volumes in your Synodes Sandboxes.
Account management
Agent Toolbox
- File System
Learn how to manage files and directories in your Sandboxes using the Synodes SDK. - Git Operations
Learn how to manage Git repositories in your Sandboxes using the Synodes SDK. - Language Server Protocol
Learn how to use Language Server Protocol (LSP) support in your Sandboxes using the Synodes SDK. - Process & Code Execution
Learn about running commands and code in isolated environments using the Synodes SDK. - Log Streaming
Learn how to stream logs from your Sandboxes using the Synodes SDK.