# Hopx Documentation ## Docs - [API key](https://docs.hopx.ai/api-key.md): How to obtain, manage, and use your HopX API keys for authentication. Complete guide to API key management, security best practices, and configuration for HopX SDK, CLI, and API access. - [Authentication](https://docs.hopx.ai/api/authentication.md): Learn how to authenticate requests to the HopX API using API keys. Secure your API requests with authentication headers, manage API keys, and understand authentication best practices. Essential for accessing HopX Control Plane and VM Agent APIs. Includes authentication examples, security guidelines,… - [Data Model](https://docs.hopx.ai/api/concepts/data-model.md): Core resources and data structures in the HopX API. Understand sandbox objects, template structures, execution results, file metadata, and other data models used throughout the HopX API. Essential for working with API responses and building integrations. Includes data model reference and field descr… - [Error Handling](https://docs.hopx.ai/api/concepts/errors.md): Error handling, error codes, and troubleshooting in the HopX API. Understand API error responses, HTTP status codes, error message formats, and how to handle errors gracefully in your applications. Essential for building robust integrations with HopX APIs. Includes error code reference and troublesh… - [Pagination](https://docs.hopx.ai/api/concepts/pagination.md): Paginating HopX API list results using cursor-based pagination. Navigate through large result sets efficiently using cursor-based pagination. Learn how to use pagination parameters, handle page boundaries, and iterate through all results. Essential for listing sandboxes, templates, and other resourc… - [Rate Limits](https://docs.hopx.ai/api/concepts/rate-limits.md): API rate limits, headers, and best practices for the HopX API. Understand rate limit policies, check rate limit headers, handle rate limit errors, and implement best practices for high-volume API usage. Essential for building scalable applications with HopX APIs. Includes rate limit examples and opt… - [Troubleshooting](https://docs.hopx.ai/api/concepts/troubleshooting.md): Common issues, solutions, and debugging tips for the HopX API. Resolve authentication errors, handle API errors, debug connection issues, and troubleshoot common problems when using HopX APIs. Essential for building reliable integrations. Includes troubleshooting guides, error solutions, and debuggi… - [Build Template](https://docs.hopx.ai/api/control-plane/build-template.md): Create a custom template from a Docker image with build steps using the HopX Control Plane API. Build custom sandbox templates with specific configurations, dependencies, and resources. Learn how to use POST /v1/templates/build endpoint to create templates from Docker images. Includes request exampl… - [Create Sandbox](https://docs.hopx.ai/api/control-plane/create-sandbox.md): Create a new sandbox from a template using the HopX Control Plane API. Provision isolated cloud environments with custom configuration, resources, and environment variables. Learn how to use POST /v1/sandboxes endpoint with Python and JavaScript SDK examples. - [Delete Sandbox](https://docs.hopx.ai/api/control-plane/delete-sandbox.md): Permanently delete a sandbox and free its resources using the HopX Control Plane API. Remove sandboxes when no longer needed to free up resources and manage costs. Learn how to use DELETE /v1/sandboxes/:id endpoint to permanently delete sandboxes and clean up resources. Includes request examples and… - [Get Sandbox](https://docs.hopx.ai/api/control-plane/get-sandbox.md): Retrieve information about a specific sandbox using the HopX Control Plane API. Get sandbox details including status, resources, connection information, and metadata. Learn how to use GET /v1/sandboxes/:id endpoint to connect to existing sandboxes and retrieve their current state. - [Get Template](https://docs.hopx.ai/api/control-plane/get-template.md): Get detailed information about a specific template using the HopX Control Plane API. Retrieve template configuration, resources, build steps, and metadata for pre-built or custom templates. Learn how to use GET /v1/templates/:name endpoint to view template details before creating sandboxes. Includes… - [Kill Sandbox](https://docs.hopx.ai/api/control-plane/kill-sandbox.md): Forcefully terminate a sandbox immediately using the HopX Control Plane API. Immediately stop a sandbox and free all resources without waiting for graceful shutdown. Learn how to use POST /v1/sandboxes/:id/kill endpoint to force-terminate sandboxes. Includes request examples and termination behavior… - [List Sandboxes](https://docs.hopx.ai/api/control-plane/list-sandboxes.md): List and filter all your sandboxes with pagination support using the HopX Control Plane API. Query sandboxes by status, region, template, or other criteria. Learn how to use GET /v1/sandboxes endpoint with filtering, pagination, and sorting options. Includes Python and JavaScript SDK examples. - [List Templates](https://docs.hopx.ai/api/control-plane/list-templates.md): List all available sandbox templates using the HopX Control Plane API. Browse pre-built and custom templates, filter by category or language, and view template configurations. Learn how to use GET /v1/templates endpoint with filtering options to discover templates for your sandbox needs. Includes re… - [Overview](https://docs.hopx.ai/api/control-plane/overview.md): Manage sandboxes, templates, and monitor resources with the HopX Control Plane API. Create and manage sandbox lifecycle, list and build templates, monitor resources, and stream real-time events. Complete reference for all Control Plane API endpoints with authentication, request formats, and response… - [Pause Sandbox](https://docs.hopx.ai/api/control-plane/pause-sandbox.md): Pause a running sandbox to temporarily suspend execution using the HopX Control Plane API. Temporarily stop sandbox execution while preserving filesystem and state. Learn how to use POST /v1/sandboxes/:id/pause endpoint to pause sandboxes, free resources, and resume later. Includes request examples… - [Resume Sandbox](https://docs.hopx.ai/api/control-plane/resume-sandbox.md): Resume a paused sandbox to continue execution using the HopX Control Plane API. Restart a previously paused sandbox to continue work where you left off. Learn how to use POST /v1/sandboxes/:id/resume endpoint to resume paused sandboxes and restore execution state. Includes request examples and state… - [Set Sandbox Timeout](https://docs.hopx.ai/api/control-plane/set-timeout.md): Set or extend the auto-shutdown timeout for a sandbox using the HopX Control Plane API. Configure when sandboxes are automatically destroyed to manage resources and costs. Learn how to use PUT /v1/sandboxes/:id/timeout endpoint to set initial timeouts or extend existing timeouts for long-running tas… - [Overview](https://docs.hopx.ai/api/introduction.md): Learn what the HopX REST API does, its main resources, and who uses it. The HopX API provides two interfaces: Control Plane API for sandbox lifecycle management and VM Agent API for code execution, file operations, and desktop automation. Get started with authentication, endpoints, and API best prac… - [Quickstart](https://docs.hopx.ai/api/quickstart.md): Get your first sandbox running with the HopX API in minutes. Complete quickstart guide for using the HopX REST API to create sandboxes, execute code, manage files, and clean up resources. Learn authentication, make your first API call, and understand API response formats. Includes curl examples and… - [Clear Execution Cache](https://docs.hopx.ai/api/vm-agent/clear-cache.md): Clear the sandbox execution result cache to free memory using the HopX VM Agent API. Remove cached execution results to free resources, force re-execution, or reset cache statistics. Learn how to use POST /cache/clear endpoint to clear all cached results. Includes request examples and cache manageme… - [Clear Environment Variables](https://docs.hopx.ai/api/vm-agent/clear-env.md): Remove all global environment variables from the sandbox using the HopX VM Agent API. Clear all environment variables to reset configuration or start fresh. Learn how to use DELETE /env endpoint to remove all variables at once. Includes request examples and cleanup best practices. - [Execute Code](https://docs.hopx.ai/api/vm-agent/execute.md): Execute code synchronously in a sandbox and get results. Run Python, JavaScript, Bash, or Go code in isolated cloud environments using the HopX VM Agent API. Learn how to use POST /execute endpoint with code examples, error handling, and result processing. - [Async Code Execution with Webhooks](https://docs.hopx.ai/api/vm-agent/execute-async.md): Execute very long-running code and receive results via webhook callback using the HopX VM Agent API. Run code asynchronously for long-running tasks and receive execution results via webhook when complete. Learn how to use POST /execute/async endpoint with webhook configuration. Includes request exam… - [Background Execution](https://docs.hopx.ai/api/vm-agent/execute-background.md): Execute code in the background and return immediately with a process ID using the HopX VM Agent API. Run long-running code without blocking, monitor process status, and retrieve results when complete. Learn how to use POST /execute/background endpoint for asynchronous code execution. Includes reques… - [Check File Exists](https://docs.hopx.ai/api/vm-agent/file-exists.md): Check if a file or directory exists in the sandbox using the HopX VM Agent API. Verify file existence before reading or writing, check directory presence, and handle missing files gracefully. Learn how to use GET /files/exists endpoint to check file existence. Includes request examples and error han… - [Get Cache Statistics](https://docs.hopx.ai/api/vm-agent/get-cache-stats.md): Get cache hit rate and usage statistics for sandbox code execution results using the HopX VM Agent API. Monitor cache performance, view hit rates, and track cached items to optimize execution speed. Learn how to use GET /cache/stats endpoint to retrieve cache statistics. Includes request examples an… - [Get Environment Variables](https://docs.hopx.ai/api/vm-agent/get-env.md): Get all global environment variables in the sandbox using the HopX VM Agent API. Retrieve environment variable values for configuration, debugging, or processing. Learn how to use GET /env endpoint to access all environment variables, handle sensitive values, and process environment data. Includes r… - [Get System Metrics](https://docs.hopx.ai/api/vm-agent/get-system-metrics.md): Get current CPU, memory, and disk usage metrics for HopX sandboxes using the HopX VM Agent API. Monitor system resources in real-time, track performance metrics, and use data for optimization and troubleshooting. Learn how to use GET /system/metrics endpoint to retrieve comprehensive system informat… - [Kill Background Process](https://docs.hopx.ai/api/vm-agent/kill-process.md): Terminate a running background code execution process in sandboxes using the HopX VM Agent API. Stop long-running or stuck processes to free resources and manage execution. Learn how to use DELETE /execute/kill endpoint to terminate processes by process ID. Includes request examples and process mana… - [List Files](https://docs.hopx.ai/api/vm-agent/list-files.md): List directory contents in the sandbox using the HopX VM Agent API. Browse filesystem structure, view file metadata including size and modification times, and navigate directories. Learn how to use GET /files/list endpoint to list files and directories with filtering options. Includes request exampl… - [List Background Processes](https://docs.hopx.ai/api/vm-agent/list-processes.md): List all background code execution processes in sandboxes and check their status using the HopX VM Agent API. Monitor running background processes, check execution status, and track process lifecycle. Learn how to use GET /processes endpoint to list processes, view status, and manage background exec… - [List System Processes](https://docs.hopx.ai/api/vm-agent/list-system-processes.md): List all running system processes in the sandbox using the HopX VM Agent API. View all system processes including background executions, system services, and user processes. Learn how to use GET /processes/system endpoint to monitor system activity and debug process issues. Includes request examples… - [Create Directory in Sandbox](https://docs.hopx.ai/api/vm-agent/mkdir.md): Create a directory in the sandbox using the HopX VM Agent API. Create new directories or directory structures for organizing files and managing filesystem hierarchy. Learn how to use POST /files/mkdir endpoint to create directories with parent directory creation. Includes request examples and direct… - [Overview](https://docs.hopx.ai/api/vm-agent/overview.md): Execute code, manage files, and control sandbox resources with the HopX VM Agent API. Run code in multiple languages, perform file operations, execute shell commands, manage environment variables, and automate desktop interactions. Complete reference for all VM Agent API endpoints with authenticatio… - [Read File from Sandbox](https://docs.hopx.ai/api/vm-agent/read-file.md): Read file contents from the sandbox as text using the HopX VM Agent API. Learn how to use GET /files/read endpoint to retrieve file contents, handle text and binary files, manage encoding, and process file data. Includes request examples and response formats. - [Remove File](https://docs.hopx.ai/api/vm-agent/remove-file.md): Delete a file or directory from the sandbox using the HopX VM Agent API. Remove files or directories to clean up sandbox filesystem, free disk space, and manage storage. Learn how to use DELETE /files/remove endpoint to delete files or directories recursively. Includes request examples and cleanup b… - [Run Command](https://docs.hopx.ai/api/vm-agent/run-command.md): Execute shell commands synchronously in the sandbox using the HopX VM Agent API. Run shell commands for system administration, package installation, and automation tasks. Learn how to use POST /commands/run endpoint to execute commands, capture output, and handle errors. Includes request examples an… - [Run Command in Background](https://docs.hopx.ai/api/vm-agent/run-command-background.md): Execute shell commands in the background and return immediately using the HopX VM Agent API. Run long-running shell commands without blocking, monitor process status, and retrieve results when complete. Learn how to use POST /commands/background endpoint for asynchronous command execution. Includes… - [Set Environment Variables](https://docs.hopx.ai/api/vm-agent/set-env.md): Replace all global environment variables in the sandbox using the HopX VM Agent API. Set or replace environment variables for code execution configuration. Learn how to use PUT /env endpoint to set all variables at once, handle variable values, and manage environment configuration. Includes request… - [Update Environment Variables](https://docs.hopx.ai/api/vm-agent/update-env.md): Update or add sandbox environment variables without removing existing ones using the HopX VM Agent API. Merge new variables with existing ones, update specific variables, and manage environment configuration incrementally. Learn how to use PATCH /env endpoint to update variables without clearing oth… - [Write File](https://docs.hopx.ai/api/vm-agent/write-file.md): Write content to a file in the sandbox using the HopX VM Agent API. Create new files or overwrite existing files with text or binary content. Learn how to use POST /files/write endpoint with encoding options, file permissions, and error handling. Includes request examples and response formats. - [Authentication](https://docs.hopx.ai/cli/commands/auth.md): Complete reference for HopX CLI authentication commands - login, logout, status, validate, and API key management. Includes OAuth login, API key creation, and authentication verification. - [Billing](https://docs.hopx.ai/cli/commands/billing.md): Complete reference for HopX CLI billing commands - view balance, billing history, invoices, and auto-recharge settings. - [Shell Commands](https://docs.hopx.ai/cli/commands/cmd.md): Execute shell commands in HopX sandboxes using the CLI cmd command. Run commands synchronously or in the background with options for timeouts, working directories, and environment variables. - [Configuration](https://docs.hopx.ai/cli/commands/config.md): Complete reference for HopX CLI configuration commands - show, set, get, and manage configuration profiles. Configure CLI settings, default values, and multiple profiles for different environments. - [Environment Variables](https://docs.hopx.ai/cli/commands/env.md): Complete reference for HopX CLI environment variable commands - list, get, set, and delete environment variables in sandboxes. Includes examples for configuring execution environments. - [File Operations](https://docs.hopx.ai/cli/commands/files.md): Complete reference for HopX CLI file commands - read, write, list, upload, download, delete, and manage files in sandboxes. Includes all flags, options, examples, and exit codes. - [Setup Wizard](https://docs.hopx.ai/cli/commands/init.md): Interactive setup wizard for first-time HopX CLI configuration. Guides you through authentication, API key creation, and initial configuration. - [Members](https://docs.hopx.ai/cli/commands/members.md): Complete reference for HopX CLI members commands - list organization members, invite new members, and remove members. - [Organization](https://docs.hopx.ai/cli/commands/org.md): Complete reference for HopX CLI organization commands - view organization info, update settings, list organizations, and switch between organizations. - [Profile](https://docs.hopx.ai/cli/commands/profile.md): Complete reference for HopX CLI profile commands - view and update user profile information. - [Code Execution](https://docs.hopx.ai/cli/commands/run.md): Execute code in HopX sandboxes using the CLI run command. Run Python, JavaScript, Bash, and Go code with options for files, environment variables, timeouts, and sandbox selection. - [Sandbox](https://docs.hopx.ai/cli/commands/sandbox.md): Complete reference for HopX CLI sandbox commands - create, list, pause, resume, kill, and manage sandboxes. Includes all flags, options, examples, and exit codes for sandbox lifecycle management. - [System](https://docs.hopx.ai/cli/commands/system.md): Complete reference for HopX CLI system commands - health checks, metrics, agent info, processes, Jupyter access, and system snapshots. Monitor and inspect sandbox system resources. - [Template](https://docs.hopx.ai/cli/commands/template.md): Complete reference for HopX CLI template commands - list, info, build, and delete templates. Manage pre-built and custom templates for sandbox creation. - [Terminal](https://docs.hopx.ai/cli/commands/terminal.md): Complete reference for HopX CLI terminal commands - connect to interactive terminal sessions, get terminal info, and get WebSocket URLs for terminal access. - [Usage](https://docs.hopx.ai/cli/commands/usage.md): Complete reference for HopX CLI usage commands - view usage summary, plans, history, and sandbox usage statistics. - [Installation](https://docs.hopx.ai/cli/installation.md): Install the HopX CLI on Linux, macOS, or Windows. Multiple installation methods including quick install script, uv, pipx, and pip. Includes verification steps and troubleshooting. - [Overview](https://docs.hopx.ai/cli/introduction.md): Official HopX CLI for managing cloud sandboxes from the command line. Install the CLI, authenticate with your API key, and start creating sandboxes, executing code, managing files, and automating workflows. Complete command-line interface reference with examples for all 15 command groups. - [Quickstart](https://docs.hopx.ai/cli/quickstart.md): Get started with the HopX CLI in 5 minutes. Learn how to install, authenticate, create your first sandbox, execute code, and manage files from the command line. - [Building an AI Code Interpreter Agent](https://docs.hopx.ai/cookbooks/ai-integration/code-interpreter-agent.md): Create a secure AI code interpreter that safely executes AI-generated code with error handling, rich outputs, and security best practices - [Multi-Agent Code Execution Workflow](https://docs.hopx.ai/cookbooks/ai-integration/multi-agent-execution.md): Coordinate multiple AI agents with code execution, parallel execution, result aggregation, and error recovery patterns - [API Testing Automation Platform](https://docs.hopx.ai/cookbooks/automation/api-testing-platform.md): Build a Postman-style API testing platform with test script execution, environment management, assertion frameworks, and test reporting - [Web Scraping Service](https://docs.hopx.ai/cookbooks/automation/web-scraping-service.md): Build a browser automation and scraping service with desktop features, screenshot capture, data extraction workflows, and rate limiting - [Data Analysis Pipeline Service](https://docs.hopx.ai/cookbooks/data-science/analysis-pipeline.md): Build automated data analysis services with multi-step workflows, data transformation chains, result export, and scheduled jobs - [Cloud Jupyter Notebook Service](https://docs.hopx.ai/cookbooks/data-science/cloud-jupyter.md): Build a Kaggle/Colab-style notebook hosting service with rich output rendering, large dataset handling, and model training workflows - [ML Model Training Service](https://docs.hopx.ai/cookbooks/data-science/ml-training-service.md): Build a cloud-based ML training platform with resource allocation, long-running execution, progress monitoring, and model checkpointing - [Browser-Based Code Editor](https://docs.hopx.ai/cookbooks/development/browser-editor.md): Build a StackBlitz-style browser IDE with client-server architecture, file operations via API, hot reload patterns, and package management - [Cloud-Based IDE Backend](https://docs.hopx.ai/cookbooks/development/cloud-ide-backend.md): Build a Replit/CodeSandbox-style online IDE with file system management, terminal emulation, and multi-file project execution - [Coding Interview Platform](https://docs.hopx.ai/cookbooks/educational/coding-interviews.md): Build a technical interview platform with problem execution environments, time limit enforcement, test case management, and performance monitoring - [Interactive Programming Tutorials](https://docs.hopx.ai/cookbooks/educational/interactive-tutorials.md): Build Codecademy-style interactive learning with step-by-step code execution, progress tracking, hint systems, and solution validation - [Building an Online Coding Platform](https://docs.hopx.ai/cookbooks/educational/online-coding-platform.md): Create a LeetCode/HackerRank-style platform with secure code execution, test case validation, and multi-language support - [Low-Code Platform Backend](https://docs.hopx.ai/cookbooks/enterprise/low-code-backend.md): Build a low-code/no-code platform backend with visual to code translation, script execution, integration patterns, and custom logic execution - [Multi-Tenant Code Execution Platform](https://docs.hopx.ai/cookbooks/enterprise/multi-tenant-execution.md): Build a SaaS platform with custom code execution featuring tenant isolation, resource quotas, security boundaries, and billing integration - [Plugin System with Code Execution](https://docs.hopx.ai/cookbooks/marketplace/plugin-system.md): Build a WordPress/Shopify-style plugin marketplace with untrusted code execution, permission systems, API access control, and sandbox isolation - [User-Defined Functions Platform](https://docs.hopx.ai/cookbooks/marketplace/user-functions.md): Build a Zapier/Make.com-style workflow automation platform with custom function execution, workflow orchestration, data transformation, and error handling - [Custom Serverless Platform](https://docs.hopx.ai/cookbooks/serverless/custom-functions.md): Build an AWS Lambda-style serverless platform with function execution, cold start optimization, event-driven execution, and resource allocation - [Edge Function Execution](https://docs.hopx.ai/cookbooks/serverless/edge-functions.md): Build edge computing functions with geographic distribution, low-latency execution, resource constraints, and request routing - [Isolated Test Execution Service](https://docs.hopx.ai/cookbooks/testing/isolated-test-execution.md): Build a CI/CD test execution platform with parallel test execution, test isolation strategies, and result aggregation - [Clearing](https://docs.hopx.ai/core-concepts/cache/clearing.md): Clear sandbox execution result cache to free memory and reset cache statistics in HopX sandboxes. Remove cached execution results to free resources, force re-execution of code, or reset cache performance metrics. Essential for memory management and debugging. Includes Python and JavaScript SDK examp… - [Cache](https://docs.hopx.ai/core-concepts/cache/index.md): Complete guide to cache management in HopX sandboxes - statistics, clearing, and optimization. Learn how to view cache statistics, clear execution cache, optimize cache usage, and monitor cache performance. Manage cache for improved execution speed and resource efficiency. Includes Python and JavaSc… - [Statistics](https://docs.hopx.ai/core-concepts/cache/statistics.md): Get cache hit rate and usage statistics for sandbox code execution results in HopX sandboxes. Monitor cache performance, view hit rates, track cached items, and optimize execution speed. Essential for understanding cache effectiveness and performance tuning. Includes Python and JavaScript SDK exampl… - [Async Webhooks](https://docs.hopx.ai/core-concepts/code-execution/async-webhooks.md): Execute very long-running code with webhook callbacks in HopX sandboxes. Run code asynchronously and receive results via webhook callbacks when execution completes. Perfect for long-running tasks, batch processing, and async workflows. Learn how to configure webhooks and handle callback responses. I… - [Background](https://docs.hopx.ai/core-concepts/code-execution/background.md): Execute code in the background without blocking. Learn how to run long-running code in HopX sandboxes asynchronously, monitor background processes, retrieve results when complete, and manage process lifecycle. Perfect for training models, processing large datasets, or running time-consuming operatio… - [Code Execution](https://docs.hopx.ai/core-concepts/code-execution/index.md): Complete guide to executing code in HopX sandboxes - synchronous, asynchronous, background, and streaming execution modes. Learn how to run Python, JavaScript, Bash, and Go code, capture rich outputs like plots and DataFrames, manage background processes, and stream execution results in real-time us… - [Process Management](https://docs.hopx.ai/core-concepts/code-execution/process-management.md): List, monitor, and manage background execution processes in HopX sandboxes. Track running processes, check execution status, terminate stuck processes, and manage process lifecycle. Essential for managing long-running code execution and debugging. Includes Python and JavaScript SDK examples and REST… - [Rich Output](https://docs.hopx.ai/core-concepts/code-execution/rich-output.md): Automatically capture plots, DataFrames, and visualizations from code execution in HopX sandboxes. Capture matplotlib plots, pandas DataFrames, plotly charts, and other rich outputs automatically without manual file handling. Perfect for data science workflows and visualization. Includes Python and… - [Streaming](https://docs.hopx.ai/core-concepts/code-execution/streaming.md): Execute code with real-time output streaming via WebSocket in HopX sandboxes. Stream execution results in real-time as code runs, monitor progress, and handle long-running operations with live updates. Perfect for interactive development and progress monitoring. Includes Python and JavaScript SDK ex… - [Synchronous](https://docs.hopx.ai/core-concepts/code-execution/synchronous.md): Execute code synchronously and wait for results. Learn how to run Python, JavaScript, Bash, and Go code in HopX sandboxes, handle execution results, manage timeouts, and process outputs. Includes SDK examples and REST API endpoints for synchronous code execution. - [Background](https://docs.hopx.ai/core-concepts/commands/background.md): Execute shell commands in the background without blocking in HopX sandboxes. Run long-running shell commands asynchronously, monitor process status, and retrieve results when complete. Perfect for package installations, data processing, and time-consuming operations. Includes Python and JavaScript S… - [Commands](https://docs.hopx.ai/core-concepts/commands/index.md): Complete guide to running shell commands in HopX sandboxes - synchronous and background command execution. Learn how to execute shell commands, run system administration tasks, install packages, and automate workflows using Python and JavaScript SDKs or REST API. Includes examples for synchronous an… - [Running](https://docs.hopx.ai/core-concepts/commands/running.md): Execute shell commands synchronously in HopX sandboxes. Run shell commands for system administration, package installation, file operations, and automation tasks. Learn how to execute commands, capture output, handle errors, and process command results using Python and JavaScript SDKs or REST API. I… - [Clipboard Operations](https://docs.hopx.ai/core-concepts/desktop/clipboard.md): Read and write clipboard content in sandbox desktop environments in HopX. Access and manipulate clipboard contents for data transfer, copy-paste operations, and desktop automation workflows. Learn how to read and write clipboard data using Python and JavaScript SDKs or REST API. Includes examples fo… - [Display Management](https://docs.hopx.ai/core-concepts/desktop/display-management.md): Configure sandbox display resolution and settings for desktop environments in HopX sandboxes. Set display resolution, configure display settings, and manage multiple displays for desktop automation and GUI testing. Learn how to configure displays using Python and JavaScript SDKs or REST API. Include… - [Desktop Automation](https://docs.hopx.ai/core-concepts/desktop/index.md): Complete guide to desktop automation in HopX sandboxes - VNC, screenshots, mouse, keyboard, and window management. Automate desktop interactions with VNC servers, capture screenshots and screen recordings, control mouse and keyboard, manage windows and displays, and use clipboard operations. Include… - [Keyboard Control](https://docs.hopx.ai/core-concepts/desktop/keyboard-control.md): Control keyboard input for sandbox desktop automation in HopX sandboxes. Send keyboard input, simulate key presses, type text, and handle keyboard shortcuts for desktop automation. Learn how to control keyboard interactions using Python and JavaScript SDKs or REST API. Includes examples for common k… - [Mouse Control](https://docs.hopx.ai/core-concepts/desktop/mouse-control.md): Control mouse input for sandbox desktop automation in HopX sandboxes. Move mouse cursor, click buttons, perform drag operations, and simulate mouse gestures for desktop automation. Learn how to control mouse interactions using Python and JavaScript SDKs or REST API. Includes examples for common mous… - [Screen Recording](https://docs.hopx.ai/core-concepts/desktop/screen-recording.md): Record sandbox screen activity as video for desktop automation in HopX sandboxes. Capture screen recordings of desktop interactions, GUI workflows, and visual demonstrations. Learn how to start and stop recordings, download video files, and use recordings for documentation or testing. Includes Pytho… - [Screenshots](https://docs.hopx.ai/core-concepts/desktop/screenshots.md): Capture screenshots of the sandbox desktop environment in HopX sandboxes. Take screenshots of desktop applications, GUIs, and visual outputs for documentation, testing, or monitoring. Learn how to capture screenshots using Python and JavaScript SDKs or REST API. Includes examples for screenshot capt… - [VNC Server](https://docs.hopx.ai/core-concepts/desktop/vnc-server.md): Start and manage VNC server for remote desktop access in HopX sandboxes. Set up VNC servers for graphical desktop environments, connect via VNC clients, and manage remote desktop sessions. Learn how to configure VNC settings, access desktop environments, and use VNC for desktop automation. Includes… - [Window Management](https://docs.hopx.ai/core-concepts/desktop/window-management.md): Manage windows on the sandbox desktop including resizing, moving, and focusing windows in HopX sandboxes. Control window positions, sizes, focus, and visibility for desktop automation workflows. Learn how to manage windows using Python and JavaScript SDKs or REST API. Includes examples for window au… - [X11 Advanced Features](https://docs.hopx.ai/core-concepts/desktop/x11-advanced.md): Advanced X11 desktop automation features for sandbox environments in HopX. Access advanced X11 capabilities for complex desktop automation, window management, and GUI interactions. Learn about X11-specific features, advanced automation techniques, and low-level desktop control. Includes Python and J… - [Clearing](https://docs.hopx.ai/core-concepts/environment/clearing.md): Remove environment variables from sandboxes. Clear all environment variables to reset configuration, remove sensitive data, or start with a clean environment. Learn how to clear variables using Python and JavaScript SDKs or REST API. Includes examples for cleanup and security best practices. - [Getting](https://docs.hopx.ai/core-concepts/environment/getting.md): Retrieve environment variables from sandboxes. Learn how to get single or all environment variables from HopX sandboxes using Python and JavaScript SDKs or REST API. Includes examples for reading variables, handling missing variables, and processing environment data. Essential for configuring code e… - [Environment Variables](https://docs.hopx.ai/core-concepts/environment/index.md): Complete guide to managing environment variables in HopX sandboxes - getting, setting, updating, and clearing environment variables. Learn how to configure execution environments, set variables for code execution, manage variables across sandbox sessions, and use environment variables in Python and… - [Setting](https://docs.hopx.ai/core-concepts/environment/setting.md): Set and replace environment variables in sandboxes. Configure execution environments by setting environment variables for code execution, API keys, database connections, and other configuration values. Learn how to set single or multiple variables using Python and JavaScript SDKs or REST API. Includ… - [Updating](https://docs.hopx.ai/core-concepts/environment/updating.md): Update and merge environment variables without replacing existing ones in HopX sandboxes. Incrementally update environment configuration, add new variables, or modify existing ones without clearing the entire environment. Essential for dynamic configuration management. Includes Python and JavaScript… - [Downloading](https://docs.hopx.ai/core-concepts/filesystem/downloading.md): Download files from sandboxes to your local filesystem. Retrieve files from HopX sandboxes to your local machine for further processing, analysis, or storage. Learn how to download single files or bulk download multiple files using Python and JavaScript SDKs or REST API. Includes examples for file d… - [Filesystem](https://docs.hopx.ai/core-concepts/filesystem/index.md): Complete guide to file operations in HopX sandboxes - reading, writing, listing, uploading, downloading, and watching files. Work with files in sandboxes using comprehensive file operations, from basic read/write to advanced file watching and bulk transfers. Includes Python and JavaScript SDK exampl… - [Listing](https://docs.hopx.ai/core-concepts/filesystem/listing.md): List directory contents and browse the filesystem in HopX sandboxes. Navigate directories, view file metadata, filter files by name or pattern, and discover generated outputs. Learn how to list files and directories using Python and JavaScript SDKs or REST API. Includes examples for directory naviga… - [Reading](https://docs.hopx.ai/core-concepts/filesystem/reading.md): Read text and binary files from sandboxes. Learn how to read file contents from HopX sandboxes using Python and JavaScript SDKs or REST API. Includes examples for reading text files, binary files, handling encoding, and processing file contents in your applications. - [Uploading](https://docs.hopx.ai/core-concepts/filesystem/uploading.md): Upload files from your local filesystem to sandboxes. Transfer files from your local machine to HopX sandboxes for processing, configuration, or data input. Learn how to upload single files or bulk upload multiple files using Python and JavaScript SDKs or REST API. Includes examples for file uploads… - [Watching](https://docs.hopx.ai/core-concepts/filesystem/watching.md): Watch filesystem for real-time changes via WebSocket in HopX sandboxes. Monitor file and directory changes in real-time, receive notifications for file modifications, and react to filesystem events. Perfect for build systems, file processing pipelines, and real-time monitoring. Includes Python and J… - [Writing](https://docs.hopx.ai/core-concepts/filesystem/writing.md): Write text and binary files to sandboxes. Learn how to create and write files in HopX sandboxes using Python and JavaScript SDKs or REST API. Includes examples for writing text files, binary files, handling encoding, appending content, and managing file permissions. Perfect for creating configuratio… - [Observability](https://docs.hopx.ai/core-concepts/observability/index.md): Complete guide to monitoring HopX sandboxes - metrics, processes, and system information for observability and debugging. Monitor CPU, memory, and disk usage, list and track running processes, view system metrics, and use observability features for performance optimization and troubleshooting. Inclu… - [System Metrics](https://docs.hopx.ai/core-concepts/observability/metrics.md): Get agent performance metrics including uptime, execution counts, and error rates. Monitor CPU, memory, and disk usage in HopX sandboxes to optimize performance and troubleshoot issues. Learn how to retrieve system metrics, track resource usage over time, and use metrics for capacity planning. Inclu… - [Monitoring](https://docs.hopx.ai/core-concepts/observability/monitoring.md): Real-time monitoring and streaming metrics via Server-Sent Events (SSE) in HopX sandboxes. Stream sandbox events, monitor system metrics in real-time, track resource usage, and receive live updates via SSE. Perfect for dashboards, alerting, and real-time monitoring. Includes Python and JavaScript SD… - [Process Monitoring](https://docs.hopx.ai/core-concepts/observability/processes.md): List and monitor system processes and background executions in HopX sandboxes. Track running processes, monitor background code execution, check process status, and manage process lifecycle. Essential for debugging, performance monitoring, and resource management. Includes Python and JavaScript SDK… - [Connecting](https://docs.hopx.ai/core-concepts/sandboxes/connecting.md): Learn how to connect to running HopX sandboxes and establish communication channels. Connect to existing sandboxes by ID, retrieve sandbox information, and resume work with previously created sandboxes. Essential for managing long-running sandboxes and resuming interrupted sessions. Includes Python… - [Creating](https://docs.hopx.ai/core-concepts/sandboxes/creating.md): Create new sandboxes from templates with custom configuration. Learn how to create isolated cloud environments using HopX templates, configure resources, set environment variables, and manage sandbox lifecycle. Includes Python and JavaScript SDK examples and REST API endpoints. - [Sandboxes](https://docs.hopx.ai/core-concepts/sandboxes/index.md): Complete guide to creating, managing, and working with HopX sandboxes - isolated cloud environments for code execution. Learn how to create sandboxes from templates, list and filter existing sandboxes, connect to sandboxes, manage state, and configure timeouts using Python and JavaScript SDKs or RES… - [Listing](https://docs.hopx.ai/core-concepts/sandboxes/listing.md): List and filter your sandboxes by status, region, template, and other criteria. Discover how to query existing sandboxes, filter by status or region, iterate through sandbox lists, and find specific sandboxes using Python and JavaScript SDKs or REST API endpoints. Includes pagination and filtering e… - [Managing State](https://docs.hopx.ai/core-concepts/sandboxes/managing-state.md): Start, stop, pause, and resume sandboxes to control their lifecycle. Learn how to manage sandbox state transitions, free resources when not in use, pause execution temporarily, and resume paused sandboxes. Essential for resource management and workflow control. Includes Python and JavaScript SDK exa… - [Timeout](https://docs.hopx.ai/core-concepts/sandboxes/timeout.md): Set and extend sandbox timeouts to control when sandboxes are automatically destroyed. Configure auto-shutdown timers to manage resources, extend timeouts for long-running tasks, and check remaining time. Essential for cost management and resource optimization. Includes Python and JavaScript SDK exa… - [Building](https://docs.hopx.ai/core-concepts/templates/building.md): Create custom templates with dependencies in HopX. Build custom sandbox templates from Docker images, configure resources, add build steps, and install dependencies. Learn how to use TemplateBuilder to create templates tailored to your needs. Includes Python and JavaScript SDK examples and REST API… - [Caching](https://docs.hopx.ai/core-concepts/templates/caching.md): Template build caching and optimization in HopX. Optimize template loading with caching strategies, reduce sandbox creation time, and manage template cache for improved performance. Learn how caching works, when to clear cache, and best practices for template optimization. Includes caching examples… - [Configuration](https://docs.hopx.ai/core-concepts/templates/configuration.md): Configure templates with resources, steps, and commands in HopX. Set vCPU, memory, and disk limits, define build steps, install packages, and configure template environments. Learn how to configure templates for optimal performance and functionality. Includes Python and JavaScript SDK examples and c… - [Getting Details](https://docs.hopx.ai/core-concepts/templates/getting-details.md): Get detailed information about templates in HopX. View template configuration, resources (vCPU, memory, disk), build steps, pre-installed packages, and metadata. Essential for choosing the right template and understanding available resources. Includes Python and JavaScript SDK examples and REST API… - [Templates](https://docs.hopx.ai/core-concepts/templates/index.md): Complete guide to HopX templates - listing, viewing, building, and configuring templates for sandbox creation. Templates define the base environment for HopX sandboxes. Learn how to list pre-built templates, view template details, build custom templates from Docker images, configure resources, and o… - [Listing](https://docs.hopx.ai/core-concepts/templates/listing.md): List available HopX sandbox templates and view their configurations. Discover pre-built templates for Python, JavaScript, Ubuntu, and other environments. Learn how to filter templates by category, language, or features, view template details, and choose the right template for your use case. Includes… - [WebSocket Terminal](https://docs.hopx.ai/core-concepts/terminal/websocket.md): Connect to an interactive terminal via WebSocket for real-time command execution in HopX sandboxes. Access interactive shell sessions, execute commands in real-time, and stream terminal output. Perfect for interactive development, debugging, and system administration. Includes Python and JavaScript… - [MCP Server Integration](https://docs.hopx.ai/guides/integrations/mcp-integration.md): Enable AI assistants to execute code in isolated HopX sandboxes using the Model Context Protocol. Connect Claude, Cursor, and other AI assistants to HopX for secure code execution. - [Welcome to HopX](https://docs.hopx.ai/index.md): Get started with HopX - your guide to building with cloud sandboxes. HopX provides instant access to isolated computing environments for executing code, running applications, and processing data. Whether you're building AI applications, running data analysis, testing code, or automating workflows, H… - [Quickstart](https://docs.hopx.ai/quickstart.md): Get started with HopX - your first HopX sandbox running in less than 2 minutes. Complete quickstart guide for creating sandboxes, executing code, and managing resources using Python SDK, JavaScript SDK, CLI, or REST API. - [Cache Management](https://docs.hopx.ai/sdk/javascript/cache.md): Cache management resource for managing execution result cache in HopX sandboxes using the JavaScript/TypeScript SDK. Complete reference for the Cache class including async methods for viewing cache statistics and clearing execution cache. Includes TypeScript examples for cache optimization. - [Command Execution](https://docs.hopx.ai/sdk/javascript/commands.md): Command execution resource for running shell commands in HopX sandboxes using the JavaScript/TypeScript SDK. Complete reference for the Commands class including async methods for running commands synchronously and in the background. Includes TypeScript examples for system administration and automati… - [Desktop Automation](https://docs.hopx.ai/sdk/javascript/desktop.md): Desktop automation resource for sandbox GUI interactions, screenshots, and VNC access in HopX using the JavaScript/TypeScript SDK. Complete reference for the Desktop class including async methods for VNC servers, screenshots, mouse and keyboard control, window management, and clipboard operations. I… - [Environment Variables](https://docs.hopx.ai/sdk/javascript/environment-variables.md): Environment variable management resource for configuring sandbox environment in HopX using the JavaScript/TypeScript SDK. Complete reference for the Environment class including async methods for getting, setting, updating, and clearing environment variables. Includes TypeScript examples for configur… - [Sandbox Error Handling](https://docs.hopx.ai/sdk/javascript/errors.md): Error classes and exception handling in the HopX JavaScript/TypeScript SDK. Handle API errors, network errors, agent errors, and validation errors gracefully. Learn about error types, error handling patterns, and best practices for robust error handling in your applications. Includes TypeScript erro… - [File Operations](https://docs.hopx.ai/sdk/javascript/files.md): File operations resource for reading, writing, and managing files in HopX sandboxes using the JavaScript/TypeScript SDK. Complete reference for the Files class including async methods for reading, writing, listing, uploading, downloading, and watching files. Includes TypeScript examples for all file… - [Installation](https://docs.hopx.ai/sdk/javascript/installation.md): Install the HopX JavaScript SDK and set up your development environment. Get started with the official JavaScript/TypeScript SDK for HopX, install via npm, configure API keys, and verify installation. Learn system requirements, installation methods, and troubleshooting tips. Includes installation ex… - [Overview](https://docs.hopx.ai/sdk/javascript/introduction.md): Official JavaScript/TypeScript SDK for HopX - Create and manage cloud sandboxes in Node.js and browsers. Install the SDK, authenticate with your API key, and start creating sandboxes, executing code, managing files, and automating desktop interactions. Complete reference with async/await examples fo… - [Quickstart](https://docs.hopx.ai/sdk/javascript/quickstart.md): Get your first sandbox running in minutes with the HopX JavaScript SDK - install, authenticate, execute code, see results. Complete quickstart guide for creating sandboxes, running JavaScript/TypeScript code, managing files, and cleaning up resources. Perfect for developers new to HopX. Includes asy… - [Template Ready Checks](https://docs.hopx.ai/sdk/javascript/ready-checks.md): Utilities for checking template readiness before use in the HopX JavaScript/TypeScript SDK. Verify templates are available and ready before creating sandboxes, check template status, and handle template availability errors. Essential for robust sandbox creation workflows. Includes TypeScript example… - [Sandbox](https://docs.hopx.ai/sdk/javascript/sandbox.md): Main sandbox class for creating and managing cloud sandboxes in JavaScript/TypeScript. Complete reference for the HopX JavaScript SDK Sandbox class including async/await methods for creating sandboxes, executing code, managing files, controlling desktop automation, and monitoring resources. Includes… - [Template Builder](https://docs.hopx.ai/sdk/javascript/template-builder.md): Fluent API for building custom sandbox templates in the HopX JavaScript/TypeScript SDK. Create custom templates from Docker images, configure resources, add build steps, and install dependencies using a fluent builder pattern. Complete reference for TemplateBuilder class with TypeScript examples and… - [Terminal Access](https://docs.hopx.ai/sdk/javascript/terminal.md): Interactive terminal resource for WebSocket-based sandbox terminal access in HopX using the JavaScript/TypeScript SDK. Complete reference for the Terminal class including async methods for connecting to interactive terminals, executing commands in real-time, and streaming terminal output. Includes T… - [TypeScript Type Definitions](https://docs.hopx.ai/sdk/javascript/types.md): TypeScript type definitions for the HopX JavaScript SDK. Complete TypeScript type definitions for sandbox objects, execution results, file metadata, template structures, and all SDK methods. Essential for type-safe development with IntelliSense support. Includes complete type reference and usage exa… - [AsyncSandbox](https://docs.hopx.ai/sdk/python/async-sandbox.md): Asynchronous sandbox class for async/await workflows in Python. Use AsyncSandbox for non-blocking operations, concurrent sandbox management, and async/await patterns. Complete reference for all async methods including creating sandboxes, executing code, and managing resources asynchronously. Include… - [Cache Management](https://docs.hopx.ai/sdk/python/cache.md): Cache management resource for managing execution result cache in HopX sandboxes using the Python SDK. Complete reference for the Cache class including methods for viewing cache statistics and clearing execution cache. Includes code examples for cache optimization and performance tuning. - [Command Execution](https://docs.hopx.ai/sdk/python/commands.md): Command execution resource for running shell commands in HopX sandboxes using the Python SDK. Complete reference for the Commands class including methods for running commands synchronously and in the background. Includes code examples for system administration, package installation, and automation t… - [Desktop Automation](https://docs.hopx.ai/sdk/python/desktop.md): Desktop automation resource for sandbox GUI interactions, screenshots, and VNC access in HopX using the Python SDK. Complete reference for the Desktop class including methods for VNC servers, screenshots, mouse and keyboard control, window management, and clipboard operations. Includes code examples… - [Environment Variables](https://docs.hopx.ai/sdk/python/environment-variables.md): Environment variable management resource for configuring sandbox environment in HopX using the Python SDK. Complete reference for the Environment class including methods for getting, setting, updating, and clearing environment variables. Includes code examples for configuration management and enviro… - [Sandbox Error Handling](https://docs.hopx.ai/sdk/python/errors.md): Error classes and exception handling in the HopX Python SDK. Handle API errors, network errors, agent errors, and validation errors gracefully. Learn about error types, error handling patterns, and best practices for robust error handling in your applications. Includes error class reference and hand… - [File Operations](https://docs.hopx.ai/sdk/python/files.md): File operations resource for reading, writing, and managing files in HopX sandboxes using the Python SDK. Complete reference for the Files class including methods for reading, writing, listing, uploading, downloading, and watching files. Includes code examples for all file operations and error handl… - [Installation](https://docs.hopx.ai/sdk/python/installation.md): Install the HopX Python SDK and set up your development environment. Get started with the official Python SDK for HopX, install via pip, configure API keys, and verify installation. Learn system requirements, installation methods, and troubleshooting tips. Includes installation examples for differen… - [Overview](https://docs.hopx.ai/sdk/python/introduction.md): Official Python SDK for HopX - Create and manage cloud sandboxes in Python. Install the SDK, authenticate with your API key, and start creating sandboxes, executing code, managing files, and automating desktop interactions. Complete reference with code examples for all SDK methods and classes. - [Sandbox Data Models](https://docs.hopx.ai/sdk/python/models.md): Data models and type definitions for the HopX Python SDK. Understand sandbox objects, execution results, file metadata, template structures, and other data models used throughout the SDK. Essential for working with SDK responses and building type-safe applications. Includes complete model reference… - [Quickstart](https://docs.hopx.ai/sdk/python/quickstart.md): Get your first sandbox running in minutes with the HopX Python SDK - install, authenticate, execute code, see results. Complete quickstart guide for creating sandboxes, running Python code, managing files, and cleaning up resources. Perfect for developers new to HopX. Includes step-by-step examples… - [Template Ready Checks](https://docs.hopx.ai/sdk/python/ready-checks.md): Utilities for checking template readiness before use in the HopX Python SDK. Verify templates are available and ready before creating sandboxes, check template status, and handle template availability errors. Essential for robust sandbox creation workflows. Includes code examples and error handling. - [Sandbox](https://docs.hopx.ai/sdk/python/sandbox.md): Main synchronous sandbox class for creating and managing cloud sandboxes in Python. Complete reference for the HopX Python SDK Sandbox class including methods for creating sandboxes, executing code, managing files, controlling desktop automation, and monitoring resources. Includes code examples for… - [Template Builder](https://docs.hopx.ai/sdk/python/template-builder.md): Fluent API for building custom sandbox templates in the HopX Python SDK. Create custom templates from Docker images, configure resources, add build steps, and install dependencies using a fluent builder pattern. Complete reference for TemplateBuilder class with code examples and template configurati… - [Terminal Access](https://docs.hopx.ai/sdk/python/terminal.md): Interactive terminal resource for WebSocket-based sandbox terminal access in HopX using the Python SDK. Complete reference for the Terminal class including methods for connecting to interactive terminals, executing commands in real-time, and streaming terminal output. Includes code examples for term… - [Supported Languages](https://docs.hopx.ai/supported-languages.md): Programming languages supported by HopX sandboxes and their specific features. Learn about Python, JavaScript, Bash, Go, and other languages available in HopX sandbox environments. ## OpenAPI Specs - [openapi](https://docs.hopx.ai/api-reference/openapi.json) ## Optional - [Console](https://console.hopx.dev) - [API GitHub](https://github.com/hopx-ai/public-api) - [SDK & CLI GitHub](https://github.com/hopx-ai/hopx)