@ai-sdk/sandbox-vercel
v1.0.138
Published
Readme
AI SDK - Vercel Sandbox
This package is experimental.
Sandbox session implementation for Vercel Sandbox.
Setup
npm i @ai-sdk/sandbox-vercelUsage
import { createVercelNetworkSandboxSession } from '@ai-sdk/sandbox-vercel';
const networkSandboxSession = await createVercelNetworkSandboxSession({
runtime: 'node24',
ports: [3000],
});
const sandboxSession = networkSandboxSession.restricted();
await sandboxSession.writeTextFile({ path: 'hello.txt', content: 'hi' });
const { stdout } = await sandboxSession.run({
command: 'cat hello.txt',
});
console.log(stdout); // "hi"
await networkSandboxSession.destroy();Use cases
- Create a network sandbox session with
createVercelNetworkSandboxSession()and pass it toHarnessAgent.createSession({ sandboxSession }). For reusable snapshots, passtemplate: await agent.getSandboxTemplate()to the creator function. - Set
sandboxIdto name a new sandbox, or persist the returned session'sid. Creation never resumes an existing sandbox and a conflicting name fails; useresumeVercelNetworkSandboxSession({ sandboxId })to reattach. - Take a network sandbox session's process-restricted subset with
networkSandboxSession.restricted()and use it with AI SDK tools that acceptexperimental_sandbox. - Adapt an existing native
SandboxwithcreateVercelSandboxSessionFromNativeSandbox(nativeSandbox)and use it with AI SDK tools that acceptexperimental_sandbox.
Authentication
Vercel Sandbox accepts VERCEL_OIDC_TOKEN, or explicit token, teamId, and projectId settings. For local OIDC authentication, link the application with vercel link, run vercel env pull, and load the generated .env.local before starting it.
Request transformations and credential brokering
Vercel Sandbox supports outbound request transformations for use cases such as credential brokering. setRequestTransformations() replaces the managed rules, while addRequestTransformations() adds rules without replacing unrelated rules.
