Overview

{
  size: number;
  sha256: string;
  etag: string;
  persistedAt: string;
}

{
  restored: false;
  reason: 'not_found';
}

{
  restored: true;
  size: number;
  sha256: string;
  etag: string;
  persistedAt: string;
}

const projectPath = 'projects/<conversation_id>/app';

// When initializing the workspace, first attempt to restore an existing checkpoint.
const restored = await context.sandbox.restore({
  path: projectPath,
  timeout: 180,
});

if (!restored.restored) {
  // If no checkpoint is available, initialize a new project workspace.
  await context.sandbox.files.makeDir(projectPath);
  // Initialize project files.
}

// Save the latest checkpoint after project files are modified.
const persisted = await context.sandbox.persist({
  path: projectPath,
  timeout: 180,
});
console.log(persisted.size, persisted.persistedAt);

await sandbox.persist(
    path='/home/user/project',
    exclude=['tmp'],
    timeout=180,
)
restored = await sandbox.restore(
    path='/home/user/project',
    timeout=180,
)

// Start a vite dev server in the sandbox, then return its access address to the frontend.
await context.sandbox.commands.run('nohup npx vite --port 5173 &', { timeout: 10 })
const previewUrl = context.sandbox.getHost(5173)
return Response.json({ previewUrl })

await ctx.sandbox.commands.run('nohup python -m http.server 8000 &', timeout=10)
preview_url = ctx.sandbox.get_host(8000)
return {'preview_url': preview_url}

const token = context.sandbox.envdAccessToken

token = ctx.sandbox.envd_access_token

interface SandboxInfo {
  instanceId: string
  sandboxToken: string
  sandboxDomain?: string
  envdVersion?: string
  expiresAt: string  // An ISO time string returned by the backend acquire/update operation.
}

@dataclass
class SandboxInfo:
    instance_id: str
    sandbox_token: str
    expires_at: str
    sandbox_domain: Optional[str] = None
    envd_version: Optional[str] = None

const info = context.sandbox.getInfo()
console.log(info.instanceId, info.expiresAt)
const remainingMs = new Date(info.expiresAt).getTime() - Date.now()
if (remainingMs < 60_000) {
  await context.sandbox.extendTimeout(600)
}

info = ctx.sandbox.get_info()
print(info.instance_id, info.expires_at)

interface UpdateResponse {
  instanceId: string
  expiresAt: string   // The actual new expiration time confirmed by the backend.
  message?: string    // Returned only when the renewal is truncated by the backend, for example, "extended to max lifetime".
}

await context.sandbox.commands.run('echo init', { timeout: 300 })
const renewed = await context.sandbox.extendTimeout(600)
console.log('new expiresAt:', renewed.expiresAt)

await ctx.sandbox.commands.run('echo init', timeout=300)
renewed = await ctx.sandbox.extend_timeout(600)
print('new expires_at:', renewed['expires_at'])

context.sandbox.kill()