SDK Overview

import { RunTools } from '@runtools/sdk';

const rt = new RunTools({ 
  apiKey: process.env.RUNTOOLS_API_KEY 
});

// Create a sandbox
const sandbox = await rt.sandboxes.create({ template: 'nodejs-20' });

// Run commands
await sandbox.exec('npm init -y');

// Write files
await sandbox.files.write('/app.js', 'console.log("Hello!")');

// Run an agent
const run = await rt.agents.run('my-bot', { 
  message: 'Build a todo app' 
});

for await (const event of run) {
  console.log(event.type, event.data);
}

rt.sandboxes.create()    // Create sandbox
rt.sandboxes.get()       // Get sandbox
rt.sandboxes.list()      // List sandboxes
sandbox.exec()           // Execute command
sandbox.files.*          // File operations
sandbox.pause()          // Pause sandbox
sandbox.resume()         // Resume sandbox
sandbox.destroy()        // Delete sandbox

rt.runtimes.create()     // Create runtime
rt.deployments.create()  // Create deployment
rt.agents.run()          // Run agent
run.pause()              // Pause run
run.resume()             // Resume run
run.cancel()             // Cancel run

rt.tools.list()          // List installed tools
rt.tools.install()       // Install tool
rt.tools.configure()     // Configure tool
rt.tools.execute()       // Execute tool
rt.tools.search()        // Search tools

rt.templates.create()    // Create template
rt.templates.list()      // List templates
rt.templates.validate()  // Validate config
rt.packages.search()     // Search packages

rt.execute()             // Execute code

hub.sessions.create()    // Create session
hub.sessions.list()      // List sessions
hub.blocks.create()      // Create context block
hub.invoke()             // Invoke with context
hub.search()             // Semantic search

const rt = new RunTools({
  apiKey: 'rt_live_xxx',
  
  // Optional configuration
  baseUrl: 'https://api.runtools.ai',  // Custom API URL
  timeout: 30000,                       // Request timeout
  retries: 3,                           // Retry failed requests
});

import { RunToolsError, RateLimitError, NotFoundError } from '@runtools/sdk';

try {
  await rt.sandboxes.get('invalid-id');
} catch (error) {
  if (error instanceof NotFoundError) {
    console.log('Sandbox not found');
  } else if (error instanceof RateLimitError) {
    console.log('Rate limited, retry after:', error.retryAfter);
  } else if (error instanceof RunToolsError) {
    console.log('API error:', error.message);
  }
}

import type {
  RunTools,
  Sandbox,
  SandboxStatus,
  AgentRun,
  AgentRunEvent,
  Tool,
  Template,
  ExecuteResult,
  // AIP Hub types
  AIPHub,
  Session,
  ContextBlock,
  SearchResult,
} from '@runtools/sdk';