Skip to content

Code API Reference

Overview

The Code module provides secure code execution capabilities in isolated environments. It supports multiple programming languages including Python, JavaScript, and more.

Requirements

  • Requires agb-code-space-1 image for code execution features

CodeExecutionResult

python
class CodeExecutionResult(ApiResponse)

Result of code execution operations.

Code

python
class Code(BaseService)

Handles code execution operations in the AGB cloud environment.

run_code

python
def run_code(code: str,
             language: str,
             timeout_s: int = 60) -> CodeExecutionResult

Execute code in the specified language with a timeout.

Arguments:

  • code str - The code to execute.
  • language str - The programming language of the code. Supported languages are: 'python', 'javascript', 'java', 'r'.
  • timeout_s int - The timeout for the code execution in seconds. Default is 60s.

Returns:

CodeExecutionResult: Result object containing success status, execution

result, and error message if any.

Raises:

CommandError: If the code execution fails or if an unsupported language is

specified.

Best Practices

  1. Validate code syntax before execution
  2. Set appropriate execution timeouts
  3. Handle execution errors and exceptions
  4. Use proper resource limits to prevent resource exhaustion
  5. Clean up temporary files after code execution

Documentation generated automatically from source code using pydoc-markdown.