Skip to content

code.md

Latest commit

 

History

History
143 lines (100 loc) · 4.02 KB

code.md

File metadata and controls

143 lines (100 loc) · 4.02 KB

Code API Reference

💡 Async Version: This documentation covers the synchronous API. For async/await support, see AsyncCode which provides the same functionality with async methods.

💻 Related Tutorial

Overview

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

Requirements

  • Requires code_latest image for code execution features

Code

class Code(BaseService)

Handles code execution operations in the AgentBay cloud environment.

run_code

def run_code(
    code: str,
    language: str,
    timeout_s: int = 60,
    stream_beta: bool = False,
    on_stdout: Optional[Callable[[str], None]] = None,
    on_stderr: Optional[Callable[[str], None]] = None,
    on_error: Optional[Callable[[Any], None]] = None
) -> EnhancedCodeExecutionResult

Execute code in the specified language with a timeout.

Arguments:

code: The code to execute.
language: The programming language of the code. Case-insensitive.

Supported values: 'python', 'javascript', 'r', 'java'. timeout_s: The timeout for the code execution in seconds. Default is 60s. Note: Due to gateway limitations, each request cannot exceed 60 seconds. stream_beta: If True, use WebSocket streaming for real-time stdout/stderr output. Requires the session to have a valid ws_url. Default is False. on_stdout: Callback invoked with each stdout chunk during streaming. Only used when stream_beta=True. on_stderr: Callback invoked with each stderr chunk during streaming. Only used when stream_beta=True. on_error: Callback invoked when an error occurs during streaming. Only used when stream_beta=True.

Returns:

EnhancedCodeExecutionResult: 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.

Important: The run_code method requires a session created with the code_latest image to function properly. If you encounter errors indicating that the tool is not found, make sure to create your session with image_id="code_latest" in the CreateSessionParams.

Example:

Execute Python code in a code execution environment

from agentbay import AgentBay, CreateSessionParams

agent_bay = AgentBay(api_key="your_api_key")
result = agent_bay.create(CreateSessionParams(image_id="code_latest"))
code_result = result.session.code.run_code("print('Hello')", "python")
print(code_result.result)
result.session.delete()

run

def run(
    code: str,
    language: str,
    timeout_s: int = 60,
    stream_beta: bool = False,
    on_stdout: Optional[Callable[[str], None]] = None,
    on_stderr: Optional[Callable[[str], None]] = None,
    on_error: Optional[Callable[[Any], None]] = None
) -> EnhancedCodeExecutionResult

Alias of run_code() for better ergonomics and LLM friendliness.

execute

def execute(
    code: str,
    language: str,
    timeout_s: int = 60,
    stream_beta: bool = False,
    on_stdout: Optional[Callable[[str], None]] = None,
    on_stderr: Optional[Callable[[str], None]] = None,
    on_error: Optional[Callable[[Any], None]] = None
) -> EnhancedCodeExecutionResult

Alias of run_code() for better ergonomics and LLM friendliness.

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

See Also

Related APIs:

Documentation generated automatically from source code using pydoc-markdown.