Server SDK Overview

The @octavus/server-sdk package provides a Node.js SDK for integrating Octavus agents into your backend application. It handles session management, streaming, and the tool execution continuation loop.

Current version: 2.9.0

Installation

For agent management (sync, validate), install the CLI as a dev dependency:

Basic Usage

Key Features

Agent Management

Agent definitions are managed via the CLI. See the CLI documentation for details.

Session Management

Create and manage agent sessions using the agent ID:

Tool Handlers

Tools run on your server with your data:

Streaming

All responses stream in real-time:

API Reference

OctavusClient

The main entry point for interacting with Octavus.

AgentSessionsApi

Manages agent sessions.

AgentSession

Handles request execution and streaming for a specific session.

FilesApi

Handles file uploads for sessions.

The client uploads files directly to S3 using the presigned upload URL. See File Uploads for the full integration pattern.

Next Steps

• Sessions — Deep dive into session management
• Tools — Implementing tool handlers
• Streaming — Understanding stream events
• Workers — Executing worker agents
• Debugging — Model request tracing and debugging