Overview

@pstdio/sdk is the public TypeScript package for Prompt Studio. It contains the extension API, the HTTP client, resource types, and prompt helpers.

Install it with:

bun add @pstdio/sdk

The package is ESM-only and has no root entry point. Import one of its subpaths.

Entry points

Entry point	Purpose
@pstdio/sdk/extensions	Contribution helpers, typed refs, command and renderer contexts, storage contracts, and the webview client
@pstdio/sdk/extensions/react	React Query hooks for webviews: useCommandQuery and useCommandMutation
@pstdio/sdk/client	The HTTP client for the Prompt Studio API: createClient and PstdioApiError
@pstdio/sdk/api	HTTP request and response types
@pstdio/sdk/resources	Resource types such as Project, Workspace, and Session
@pstdio/sdk/prompts	renderPrompt(template, data) for Mustache prompt templates
@pstdio/sdk/hooks	Hook context and payload types
@pstdio/sdk/data	Draft layout, frontmatter, and ID or name lookup helpers
@pstdio/sdk/testing	Command contexts and in-memory storage, file, and resource adapters for extension tests

Every entry except @pstdio/sdk/extensions/react works without React. That entry needs the optional peer dependencies react (19) and @tanstack/react-query (5). The type declarations include every type they reference, so they also type-check with skipLibCheck: false.

The method reference lists the client groups and what each entry exports.

Where to start

Extension authors should start with the workbench cookbook and Extension Lab. These examples use public contracts for editing, persistence, inspectors, shared mode panels, and navigation. The Extension API reference covers every contribution.

Scripts and services that call a running Prompt Studio use @pstdio/sdk/client. See the client guide.

People who build their own host app on the workbench should read the Workbench reference. Host registries and layout controllers are not extension authoring APIs.