Octavus Docs

Getting Started

  • Introduction
  • Quick Start

Server SDK

  • Overview
  • Sessions
  • Tools
  • Streaming
  • CLI
  • Workers
  • Debugging

Client SDK

  • Overview
  • Messages
  • Streaming
  • Operations
  • Socket Transport
  • HTTP Transport
  • Structured Output
  • File Uploads
  • Error Handling
  • Client Tools

Protocol

  • Overview
  • Input & Resources
  • Triggers
  • Tools
  • Skills
  • Handlers
  • Agent Config
  • Provider Options
  • Skills Advanced Guide
  • Types
  • Workers

API Reference

  • Overview
  • Sessions
  • Agents

Examples

  • Overview
  • Next.js Chat
  • Socket Chat

Migration

  • Migrating from v1 to v2

Octavus Documentation

Learn how to build, deploy, and manage AI agents with Octavus. From quick starts to advanced protocol configurations.

Get Started

New to Octavus? Start here

Learn the basics of Octavus and how to integrate AI agents into your application.

IntroductionQuick Start

Explore by Topic

Server SDK

Backend integration with @octavus/server-sdk for Node.js applications.

7 articles

Client SDK

Frontend integration with @octavus/react for React applications and @octavus/client-sdk for other frameworks.

10 articles

Protocol

Agent protocol reference - how to define agent behavior with YAML.

11 articles

API Reference

REST API reference for the Octavus platform.

3 articles

Examples

Complete working examples demonstrating Octavus integration patterns.

3 articles

Migration

Upgrade guides for migrating between major versions of the Octavus SDKs.

1 article

Quick Links

GitHub Repository· Source code & packagesnpm Packages· @octavus/* packagesAll Docs (Markdown)· Download everythingllms.txt· Documentation index for AI agents