Skip to main content
The Yasumu SDK provides a programmatic interface to interact with Yasumu workspaces, REST entities, email testing, and environment management.

​
Installation

Install the @yasumu/core package: 
npm install @yasumu/core
For schema parsing capabilities: 
npm install @yasumu/schema

​
Quick start

import { createYasumu } from '@yasumu/core';

const yasumu = createYasumu({
  platformBridge: myPlatformBridge,
  events: {
    onWorkspaceActivated: (workspace) => {
      console.log('Workspace activated:', workspace.name);
    },
  },
});

await yasumu.initialize();

const workspace = await yasumu.workspaces.create({
  name: 'My Project',
  path: '/path/to/workspace',
});

const request = await workspace.rest.create({
  name: 'Get Users',
  url: 'https://api.example.com/users',
  method: 'GET',
});

​
Architecture

The Yasumu SDK is organized into several key components:

​
Core classes

  • Yasumu - Main SDK instance that coordinates all operations
  • WorkspaceManager - Manages workspace lifecycle and activation
  • Workspace - Represents a Yasumu workspace with modules

​
Modules

  • RestModule - Manage REST API requests and entities
  • EmailModule - SMTP email testing capabilities
  • EnvironmentManager - Manage environment variables and secrets

​
Event system

  • YasumuEventBus - Type-safe event emitter for SDK events

​
Package exports

The SDK exports from multiple packages:
  • @yasumu/core - Core SDK functionality
  • @yasumu/common - Common types and interfaces
  • @yasumu/rpc - RPC client for platform communication

​
Next steps

Installation

Install and configure the SDK

Yasumu class

Main SDK instance

Workspace

Workspace management

REST module

REST API testing

Build docs developers (and LLMs) love

Get started for freeTalk to us