SDK/SDK overview

SDK overview

Choose the server-side execution client or the TypeScript agent authoring toolkit.

OpenPond has two complementary SDKs. A server calling OpenPond uses openpond-sdk. An agent project defining behavior uses openpond-agent-sdk. Both require Node.js 22.14 or newer.

Choose a package

Package	What it provides	What your application supplies
`openpond-sdk`	Clients for Work, sandboxes, workflows, experiments, and Project Actions	Server-side credentials, application authorization, output storage, and the chosen runtime
`openpond-agent-sdk`	TypeScript Agent source, CLI, local runtime, manifests, validation, and evals	Agent source and integrations; reviewed delivery through a Profile for hosted use
`@openpond/evals`	Portable evaluation protocols and helpers	Execution adapters, evidence, persistence, and authorization
`@openpond/harness`	Portable releases and refinement policy	Model streams, authorized evidence, scheduling, validation, and persistence

First server-side Work request

Install the execution client:

bash

npm install openpond-sdk

Keep the API key in your server environment. This example explicitly retains the sandbox so outputs can be inspected and saved before cleanup:

import { createOpenPondClient } from "openpond-sdk";

const openpond = createOpenPondClient({
  apiKey: process.env.OPENPOND_API_KEY!,
});

const result = await openpond.work.run({
  prompt: "Write a short project summary to /workspace/outputs/summary.md",
  cleanup: "keep",
});

console.log(result.sandboxId, result.outputs);

This starts model and sandbox work and can incur usage charges. Review access and limits before running it. Your server owns durable output storage; download retained outputs, verify persistence, and then clean up the sandbox. For an automatic lifecycle, supply the package's persistOutput callback before choosing cleanup: "delete".

See Sandbox execution for raw commands and files, runtime lifecycle for cleanup, and budgets for resource controls. The package README owns the full executable API examples.

First agent project

Use the authoring package when you want to define reusable agent behavior:

bash

npm install openpond-agent-sdk
npx openpond-agent init blank-agent --cwd ./my-agent
cd my-agent
npx openpond-agent inspect --json
npx openpond-agent validate --json

Inspection and validation do not deliver an Agent to a hosted Profile. Review setup requirements and eval configuration separately before running model-backed evaluations or publishing a package. Continue with Agent SDK, Skills, and Profiles.

Hosting and credentials

The execution SDK is server-only. Keep API keys out of browser code and NEXT_PUBLIC_* variables. Hosted models and hosted sandboxes have separate permissions and budgets. Custom model and sandbox endpoints each need their own credentials; the SDK does not borrow a credential from another service.

Portable Evals and Harness packages do not start hosted work, resolve your credentials, or persist artifacts. Import them directly when you are building your own host. Use Cloud when OpenPond should own the hosted infrastructure.

View as Markdown