--- title: "CodeInterpreter" hideTitleOnPage: true --- ## CodeInterpreter Handles Python code interpretation and execution within a Sandbox. Provides methods to execute code (currently only Python) in isolated interpreter contexts, manage contexts, and stream execution output via callbacks. For other languages, use the `codeRun` method from the `Process` interface, or execute the appropriate command directly in the sandbox terminal. ### Constructors #### new CodeInterpreter() ```ts new CodeInterpreter( clientConfig: Configuration, apiClient: InterpreterApi, getPreviewToken: () => Promise, ensureToolboxUrl: () => Promise): CodeInterpreter ``` **Parameters**: - `clientConfig` _Configuration_ - `apiClient` _InterpreterApi_ - `getPreviewToken` _ =\> Promise\_ - `ensureToolboxUrl` _ =\> Promise\_ **Returns**: - `CodeInterpreter` ### Methods #### createContext() ```ts createContext(cwd?: string): Promise ``` Create a new isolated interpreter context. **Parameters**: - `cwd?` _string_ - Working directory for the context. Uses sandbox working directory if omitted. **Returns**: - `Promise` - The created context. **Example:** ```ts const ctx = await sandbox.codeInterpreter.createContext() await sandbox.codeInterpreter.runCode('x = 10', { context: ctx }) await sandbox.codeInterpreter.deleteContext(ctx.id!) ``` *** #### deleteContext() ```ts deleteContext(context: InterpreterContext): Promise ``` Delete an interpreter context and shut down its worker process. **Parameters**: - `context` _InterpreterContext_ - Context to delete. **Returns**: - `Promise` **Example:** ```ts const ctx = await sandbox.codeInterpreter.createContext() // ... use context ... await sandbox.codeInterpreter.deleteContext(ctx) ``` *** #### listContexts() ```ts listContexts(): Promise ``` List all user-created interpreter contexts (default context is excluded). **Returns**: - `Promise` - List of contexts. **Example:** ```ts const contexts = await sandbox.codeInterpreter.listContexts() for (const ctx of contexts) { console.log(ctx.id, ctx.language, ctx.cwd) } ``` *** #### runCode() ```ts runCode(code: string, options: RunCodeOptions): Promise ``` Run Python code in the sandbox. **Parameters**: - `code` _string_ - Code to run. - `options` _RunCodeOptions = {}_ - Execution options (context, envs, callbacks, timeout). **Returns**: - `Promise` - ExecutionResult containing stdout, stderr and optional error info. **Example:** ```ts const handleStdout = (msg: OutputMessage) => process.stdout.write(`STDOUT: ${msg.output}`) const handleStderr = (msg: OutputMessage) => process.stdout.write(`STDERR: ${msg.output}`) const handleError = (err: ExecutionError) => console.error(`ERROR: ${err.name}: ${err.value}\n${err.traceback ?? ''}`) const code = ` import sys import time for i in range(5): print(i) time.sleep(1) sys.stderr.write("Counting done!") ` const result = await codeInterpreter.runCode(code, { onStdout: handleStdout, onStderr: handleStderr, onError: handleError, timeout: 10, }) ``` *** ## ExecutionError Represents an error that occurred during code execution. **Properties**: - `name` _string_ - Error type/class name (e.g., "ValueError", "SyntaxError"). - `traceback?` _string_ - Full traceback for the error, if available. - `value` _string_ - Error value/message. ## ExecutionResult Result of code execution. **Properties**: - `error?` _ExecutionError_ - Details about an execution error, if one occurred. - `stderr` _string_ - Standard error captured during execution. - `stdout` _string_ - Standard output captured during execution. ## OutputMessage Represents stdout or stderr output from code execution. **Properties**: - `output` _string_ - Output content. ## RunCodeOptions Options for executing code in the interpreter. **Properties**: - `context?` _InterpreterContext_ - Interpreter context to run code in. - `envs?` _Record\_ - Environment variables for this execution. - `onError()?` _$error: ExecutionError$ =\> any_ - Callback for execution errors (e.g., runtime exceptions). **Parameters**: - `error` _ExecutionError_ **Returns**: - `any` - `onStderr()?` _$message: OutputMessage$ =\> any_ - Callback for stderr messages. **Parameters**: - `message` _OutputMessage_ **Returns**: - `any` - `onStdout()?` _$message: OutputMessage$ =\> any_ - Callback for stdout messages. **Parameters**: - `message` _OutputMessage_ **Returns**: - `any` - `timeout?` _number_ - Timeout in seconds. Set to 0 for no timeout. Default is 10 minutes.

code-interpreter