Saltar a contenido

Referencia

Todos los parámetros, clases y comandos. Si buscas cómo hacer algo, empieza por las Guías; esta sección es para consultar.

  • Python


    Sandbox, AsyncSandbox, subclientes (commands, files, pty, git, agent…), pool, modelos, opcionales, excepciones y el shim de E2B, generados desde los docstrings.

    Referencia de Python

  • TypeScript


    Las mismas clases en camelCase y milisegundos, con la tabla de equivalencias.

    Referencia de TypeScript

  • CLI


    rayito doctor, image, sandbox, stack, events, template, domain y agent.

    CLI

  • Errores


    Cada excepción en Python y TypeScript, cuándo ocurre y qué hacer.

    Errores

Todas las páginas de la sección:

Página Qué contiene
Python: resumen qué se importa de rayito y de rayito.e2b, y por dónde empezar
Python: Sandbox Sandbox y AsyncSandbox: crear, conectar, ciclo de vida, red, persistencia
Python: Subclientes commands, files, pty, git y agent, con sus handles
Python: Pool SandboxPool, AsyncSandboxPool, PoolConfig y los backends
Python: Modelos los tipos de datos que devuelven y aceptan las llamadas
Python: Opcionales las clases de las funciones opcionales (secretos, montajes, eventos, templates…)
Python: Excepciones la jerarquía de excepciones
Python: Shim E2B rayito.e2b
TypeScript clases y métodos públicos del paquete npm y de rayito/e2b
CLI cada orden de rayito y sus opciones
Errores cada error en Python y TypeScript, cuándo ocurre y qué hacer
Variables de entorno RAYITO_* y las variables de AWS que leen el SDK y la CLI
Límites límites de la plataforma, versionado y compatibilidad SDK ↔ rayd
Otros lenguajes (gRPC) hablar con rayd desde un lenguaje sin SDK oficial
Changelog los cambios de cada versión

Python y TypeScript: cómo se corresponden los nombres

Los dos SDK tienen la misma superficie. Tres reglas convierten un nombre en el otro:

Regla Python TypeScript
snake_case → camelCase run_code, get_info, write_files, sandbox_id runCode, getInfo, writeFiles, sandboxId
segundos → milisegundos, con sufijo Ms timeout=60, request_timeout=30 timeoutMs: 60_000, requestTimeoutMs: 30_000
argumentos con nombre → un objeto de opciones commands.run("ls", background=True, cwd="/tmp") commands.run("ls", { background: true, cwd: "/tmp" })

Excepciones a la regla de los milisegundos: los campos que la API de AWS da en segundos se quedan en segundos en los dos SDK (IdlePolicy.max_idle_seconds / idle.maxIdleSeconds, expires_in / expiresIn de las URLs de S3).

Concepto Python TypeScript
Liberar al salir with Sandbox.create() as sbx: await using sbx = await Sandbox.create();
Sin límite de tiempo timeout=None timeoutMs: 0
Sin auto-suspensión idle=None idle: null
Iterar un listado for item in Sandbox.list(): for await (const item of Sandbox.list())
Excepciones ...Exception ...Error
Cancelar una llamada request_timeout= signal: AbortSignal (además de requestTimeoutMs)