TypeScript SDK

The Declaw TypeScript SDK is available on npm and targets Node.js 18+ and modern browsers with native fetch support.

Installation

npm install @declaw/sdk

Environment variables

export DECLAW_API_KEY="your-api-key"
export DECLAW_DOMAIN="api.declaw.ai"         # or your enterprise on-prem domain

ConnectionConfig

ConnectionConfig holds the API key, domain, port, and base URL. It is constructed automatically when you pass apiKey and domain to Sandbox.create(). Instantiate it directly when you need to share connection settings.

import { ConnectionConfig } from '@declaw/sdk';

const config = new ConnectionConfig({
  apiKey: 'your-api-key',
  domain: '104.198.24.180:8080',
  requestTimeout: 30_000, // ms
});

`ConnectionConfigOptions`

string

API key sent as X-API-Key. Defaults to process.env.DECLAW_API_KEY.

string

default:"process.env.DECLAW_DOMAIN or 'localhost'"

Hostname of the Declaw API. Supports host:port format — the port is parsed from the string.

number

default:"443"

Explicit port override. Ignored when domain already contains a port.

string

Full URL override (e.g. http://localhost:8080). When set, domain, port, and scheme detection are bypassed.

number

Default per-request HTTP timeout in milliseconds.

Properties

Property	Type	Description
`config.apiKey`	`string`	Resolved API key.
`config.domain`	`string`	Resolved hostname (without port).
`config.port`	`number`	Resolved port.
`config.apiUrl`	`string`	Fully constructed base URL.
`config.requestTimeout`	`number \| undefined`	Default timeout in ms.

SandboxOpts

SandboxOpts is the options object passed to Sandbox.create().

import { Sandbox } from '@declaw/sdk';

const sbx = await Sandbox.create({
  template: 'base',
  timeout: 300,
  envs: { MY_VAR: 'hello' },
  apiKey: 'your-api-key',
  domain: '104.198.24.180:8080',
});

string

default:"'base'"

Template ID or alias to boot.

number

default:"300"

Sandbox lifetime in seconds.

Record<string, string>

Arbitrary key-value pairs attached to the sandbox.

Record<string, string>

Environment variables injected at boot time.

boolean

default:"true"

Whether to enable the edge proxy security proxy.

boolean

default:"true"

When false, blocks all outbound traffic (deny_out: ["0.0.0.0/0"]).

SandboxNetworkOpts

Fine-grained network configuration. Overrides allowInternetAccess.

SecurityPolicy

Full security policy. See Security Policy.

SandboxLifecycle

Sandbox lifecycle settings (onTimeout, autoResume).

string

API key override for this call.

string

Domain override for this call.

string

Full URL override for this call.

number

Per-request HTTP timeout in milliseconds.

Quick example

import { Sandbox } from '@declaw/sdk';

const sbx = await Sandbox.create({
  apiKey: 'your-api-key',
  domain: '104.198.24.180:8080',
});

try {
  const result = await sbx.commands.run("echo 'hello from Declaw'");
  console.log(result.stdout);
} finally {
  await sbx.kill();
}

Using `await using` (TypeScript 5.2+)

import { Sandbox } from '@declaw/sdk';

await using sbx = await Sandbox.create({
  apiKey: 'your-api-key',
  domain: '104.198.24.180:8080',
});

const result = await sbx.commands.run("node --version");
console.log(result.stdout);
// sbx.close() is called automatically at block exit

await using calls sbx.close() which releases the HTTP client but does not kill the sandbox. Call await sbx.kill() explicitly to destroy the sandbox.

What’s exported

import {
  // Connection
  ConnectionConfig,
  // Sandbox
  Sandbox,
  // Templates
  Template,
  TemplateBase,
  // Security
  createSecurityPolicy,
  createPIIConfig,
  PIIType,
  RedactionAction,
  createInjectionDefenseConfig,
  InjectionSensitivity,
  InjectionAction,
  createNetworkPolicy,
  createTransformationRule,
  TransformDirection,
  createAuditConfig,
  createEnvSecurityConfig,
  ALL_TRAFFIC,
  // Errors
  SandboxError,
  TimeoutError,
  NotFoundError,
  AuthenticationError,
  CommandExitError,
} from '@declaw/sdk';

Python SDK

TypeScript SDK

Go SDK

TypeScript SDK

Installation

Environment variables

ConnectionConfig

`ConnectionConfigOptions`

Properties

SandboxOpts

Quick example

Using `await using` (TypeScript 5.2+)

What’s exported

​Installation

​Environment variables

​ConnectionConfig

​ConnectionConfigOptions

​Properties

​SandboxOpts

​Quick example

​Using await using (TypeScript 5.2+)

​What’s exported

Installation

Environment variables

ConnectionConfig

`ConnectionConfigOptions`

Properties

SandboxOpts

Quick example

Using `await using` (TypeScript 5.2+)

What’s exported