APIZDocs

APIZ guide

Choose And Use An APIZ SDK

APIZ provides host SDKs for running agents and a separate SDK for writing Scripted Policies. They serve different execution environments.

What you want to doUseYour code runs in
Give an E2B, Daytona, Modal or Vercel sandbox temporary accessPython apiz-sdk or TypeScript @apiz/sdkYour trusted application / orchestrator
Issue and revoke Client credential groupsThe same host SDKsYour trusted application / orchestrator
Inspect a request and allow, deny or modify it in a Policy@apiz/policy-sdkAPIZ's restricted Policy evaluator after compilation
Let an agent call an upstream serviceAPIZ CLI setup plus that service's official CLI/SDKThe sandbox

Install apiz-sdk from PyPI, or @apiz/sdk and @apiz/policy-sdk from npm. Each language guide starts with a new project and includes the files needed for its tutorial. You do not need the APIZ source repository.

Start With Your Language

GuideWhat you will learn
Python SDKInstallation, complete E2B + CLI + boto3 tutorial, async, explicit lifetime, management APIs and recovery
TypeScript SDKESM setup, full Node host tutorial, native sandbox customization, cancellation, management APIs and errors
Policy SDKInstallation, build/test a project, allow/deny/edit/reply/rate-limit cases and publication workflow

Pick A Sandbox Provider

Use each provider’s native SDK for creation, images, files, commands and deletion. APIZ receives no sandbox object. Each provider guide includes Python and TypeScript code, dependencies, configuration, cleanup, troubleshooting and evidence limits.

ProviderGuide focusValidation scope
E2BFirst tutorial; sync/async Python and Node commands/filesEarlier hosted toolchain evidence; this API revision validated locally
DaytonaProcess API and organization network restrictionsLocal simulation/native contracts; hosted acceptance deferred
ModalApp/image/client ownership and Python .aioNative contracts/local tests; earlier hosted toolchain evidence is separately dated
VercelScoped Python session, account credentials and native commandsNative contracts/local tests; earlier hosted toolchain evidence is separately dated

Follow The Credential Flow

Trusted host                        Native sandbox
User API Key + provider key         APIZ Client credentials only
  |                                   |
  +-- create native sandbox ----------+
  +-- optional CLI installation ------> install.sh
  +-- issue credentials
  +-- run with exported env ---------> APIZ CLI setup
                                      |
                                      +-- official SDK / CLI --> APIZ --> upstream
  +-- revoke credential group
  +-- delete sandbox (caller-owned)

The guest uses its ordinary tools. The host SDK provisions access; it does not replace the agent's official upstream SDK. Upstream secrets stay inside APIZ. Default handoff token authority is not narrowed by selecting a setup Binding; configure Client Bindings and Policies for that boundary.

Complete Your First Run

  1. In the Web Console, configure an API connection, Policy, Client and Binding.
  2. Create a scoped User API Key and keep it on the host.
  3. Follow the language guide's install and environment steps.
  4. Run the E2B tutorial, or adapt the native provider guide to your environment.
  5. Confirm the official-tool request in Access Logs, then confirm credential revocation and caller-owned sandbox cleanup.

The host SDK and Policy SDK remain separate packages with different execution contracts. Use the language and provider guides above to build your integration.