# Octavus AI - LLM Documentation Index > Octavus is an agent orchestration platform that lets developers define, manage, and deploy AI agents through a unified service. This file helps AI assistants and LLMs discover and navigate Octavus documentation. ## Overview - **Total Pages**: 37 documentation pages across 7 sections - **Website**: https://octavus.ai - **Documentation**: https://octavus.ai/docs - **GitHub**: https://github.com/octavus-ai/agent-sdk ## SDK Packages (npm) | Package | Description | npm | |---------|-------------|-----| | @octavus/core | Shared types and utilities | https://www.npmjs.com/package/@octavus/core | | @octavus/server-sdk | Server SDK for backend integration | https://www.npmjs.com/package/@octavus/server-sdk | | @octavus/client-sdk | Framework-agnostic client SDK | https://www.npmjs.com/package/@octavus/client-sdk | | @octavus/react | React hooks and bindings | https://www.npmjs.com/package/@octavus/react | | @octavus/cli | CLI for agent management | https://www.npmjs.com/package/@octavus/cli | ## Documentation Index ### Getting Started Learn the basics of Octavus and how to integrate AI agents into your application. **Introduction** - URL: https://octavus.ai/docs/getting-started/introduction - Markdown: https://octavus.ai/api/docs/getting-started/introduction.md - Description: Overview of Octavus AI - an agent orchestration platform for developers. **Quick Start** - URL: https://octavus.ai/docs/getting-started/quickstart - Markdown: https://octavus.ai/api/docs/getting-started/quickstart.md - Description: Get your first Octavus agent running in minutes. ### Server SDK Backend integration with @octavus/server-sdk for Node.js applications. **Overview** - URL: https://octavus.ai/docs/server-sdk/overview - Markdown: https://octavus.ai/api/docs/server-sdk/overview.md - Description: Introduction to the Octavus Server SDK for backend integration. **Sessions** - URL: https://octavus.ai/docs/server-sdk/sessions - Markdown: https://octavus.ai/api/docs/server-sdk/sessions.md - Description: Managing agent sessions with the Server SDK. **Tools** - URL: https://octavus.ai/docs/server-sdk/tools - Markdown: https://octavus.ai/api/docs/server-sdk/tools.md - Description: Implementing tool handlers with the Server SDK. **Streaming** - URL: https://octavus.ai/docs/server-sdk/streaming - Markdown: https://octavus.ai/api/docs/server-sdk/streaming.md - Description: Understanding stream events from the Server SDK. **CLI** - URL: https://octavus.ai/docs/server-sdk/cli - Markdown: https://octavus.ai/api/docs/server-sdk/cli.md - Description: Command-line interface for validating and syncing agent definitions. **Workers** - URL: https://octavus.ai/docs/server-sdk/workers - Markdown: https://octavus.ai/api/docs/server-sdk/workers.md - Description: Executing worker agents with the Server SDK. **Debugging** - URL: https://octavus.ai/docs/server-sdk/debugging - Markdown: https://octavus.ai/api/docs/server-sdk/debugging.md - Description: Model request tracing and debugging tools for Octavus agents. ### Client SDK Frontend integration with @octavus/react for React applications and @octavus/client-sdk for other frameworks. **Overview** - URL: https://octavus.ai/docs/client-sdk/overview - Markdown: https://octavus.ai/api/docs/client-sdk/overview.md - Description: Introduction to the Octavus Client SDKs for building chat interfaces. **Messages** - URL: https://octavus.ai/docs/client-sdk/messages - Markdown: https://octavus.ai/api/docs/client-sdk/messages.md - Description: Working with message state in the Client SDK. **Streaming** - URL: https://octavus.ai/docs/client-sdk/streaming - Markdown: https://octavus.ai/api/docs/client-sdk/streaming.md - Description: Building streaming UIs with the Client SDK. **Operations** - URL: https://octavus.ai/docs/client-sdk/execution-blocks - Markdown: https://octavus.ai/api/docs/client-sdk/execution-blocks.md - Description: Showing agent operations and progress with the Client SDK. **Socket Transport** - URL: https://octavus.ai/docs/client-sdk/socket-transport - Markdown: https://octavus.ai/api/docs/client-sdk/socket-transport.md - Description: Using WebSocket or SockJS for real-time streaming with Octavus. **HTTP Transport** - URL: https://octavus.ai/docs/client-sdk/http-transport - Markdown: https://octavus.ai/api/docs/client-sdk/http-transport.md - Description: Using HTTP/SSE for streaming with Octavus in Next.js, Express, and other frameworks. **Structured Output** - URL: https://octavus.ai/docs/client-sdk/structured-output - Markdown: https://octavus.ai/api/docs/client-sdk/structured-output.md - Description: Rendering structured object responses with custom UI components. **File Uploads** - URL: https://octavus.ai/docs/client-sdk/file-uploads - Markdown: https://octavus.ai/api/docs/client-sdk/file-uploads.md - Description: Uploading images and files for vision models and document processing. **Error Handling** - URL: https://octavus.ai/docs/client-sdk/error-handling - Markdown: https://octavus.ai/api/docs/client-sdk/error-handling.md - Description: Handling errors in streaming responses with structured error types. **Client Tools** - URL: https://octavus.ai/docs/client-sdk/client-tools - Markdown: https://octavus.ai/api/docs/client-sdk/client-tools.md - Description: Handling tool calls on the client side for interactive UI and browser-only operations. ### Protocol Agent protocol reference - how to define agent behavior with YAML. **Overview** - URL: https://octavus.ai/docs/protocol/overview - Markdown: https://octavus.ai/api/docs/protocol/overview.md - Description: Introduction to Octavus agent protocols. **Input & Resources** - URL: https://octavus.ai/docs/protocol/input-resources - Markdown: https://octavus.ai/api/docs/protocol/input-resources.md - Description: Defining agent inputs and persistent resources. **Triggers** - URL: https://octavus.ai/docs/protocol/triggers - Markdown: https://octavus.ai/api/docs/protocol/triggers.md - Description: Defining how agents are invoked. **Tools** - URL: https://octavus.ai/docs/protocol/tools - Markdown: https://octavus.ai/api/docs/protocol/tools.md - Description: Defining external tools implemented in your backend. **Skills** - URL: https://octavus.ai/docs/protocol/skills - Markdown: https://octavus.ai/api/docs/protocol/skills.md - Description: Using Octavus skills for code execution and specialized capabilities. **Handlers** - URL: https://octavus.ai/docs/protocol/handlers - Markdown: https://octavus.ai/api/docs/protocol/handlers.md - Description: Defining execution handlers with blocks. **Agent Config** - URL: https://octavus.ai/docs/protocol/agent-config - Markdown: https://octavus.ai/api/docs/protocol/agent-config.md - Description: Configuring the agent model and behavior. **Provider Options** - URL: https://octavus.ai/docs/protocol/provider-options - Markdown: https://octavus.ai/api/docs/protocol/provider-options.md - Description: Configuring provider-specific tools and features. **Skills Advanced Guide** - URL: https://octavus.ai/docs/protocol/skills-advanced - Markdown: https://octavus.ai/api/docs/protocol/skills-advanced.md - Description: Best practices and advanced patterns for using Octavus skills. **Types** - URL: https://octavus.ai/docs/protocol/types - Markdown: https://octavus.ai/api/docs/protocol/types.md - Description: Defining custom types for structured data in your agent protocol. **Workers** - URL: https://octavus.ai/docs/protocol/workers - Markdown: https://octavus.ai/api/docs/protocol/workers.md - Description: Defining worker agents for background and task-based execution. ### API Reference REST API reference for the Octavus platform. **Overview** - URL: https://octavus.ai/docs/api-reference/overview - Markdown: https://octavus.ai/api/docs/api-reference/overview.md - Description: REST API overview and authentication. **Sessions** - URL: https://octavus.ai/docs/api-reference/sessions - Markdown: https://octavus.ai/api/docs/api-reference/sessions.md - Description: Session management API endpoints. **Agents** - URL: https://octavus.ai/docs/api-reference/agents - Markdown: https://octavus.ai/api/docs/api-reference/agents.md - Description: Agent management API endpoints. ### Examples Complete working examples demonstrating Octavus integration patterns. **Overview** - URL: https://octavus.ai/docs/examples/overview - Markdown: https://octavus.ai/api/docs/examples/overview.md - Description: Complete integration examples for different architectures. **Next.js Chat** - URL: https://octavus.ai/docs/examples/nextjs-chat - Markdown: https://octavus.ai/api/docs/examples/nextjs-chat.md - Description: Building a chat interface with Next.js and HTTP transport. **Socket Chat** - URL: https://octavus.ai/docs/examples/socket-chat - Markdown: https://octavus.ai/api/docs/examples/socket-chat.md - Description: Building a chat interface with SockJS for real-time frameworks. ### Migration Upgrade guides for migrating between major versions of the Octavus SDKs. **Migrating from v1 to v2** - URL: https://octavus.ai/docs/migration/v1-to-v2 - Markdown: https://octavus.ai/api/docs/migration/v1-to-v2.md - Description: Complete guide for upgrading from Octavus SDK v1.x to v2.0. ## Programmatic Access ### Endpoints | Endpoint | Description | |----------|-------------| | `GET /llms.txt` | This file - documentation index for LLMs | | `GET /api/docs/{slug}.md` | Single doc page as markdown | | `GET /api/docs/all.md` | All documentation as single markdown file | | `GET /sitemap.xml` | XML sitemap for crawlers | ### Example: Fetch a single doc ```bash curl https://octavus.ai/api/docs/getting-started/introduction.md ``` ### Example: Fetch all documentation ```bash curl https://octavus.ai/api/docs/all.md ``` ## All Documentation Slugs ``` getting-started/introduction getting-started/quickstart server-sdk/overview server-sdk/sessions server-sdk/tools server-sdk/streaming server-sdk/cli server-sdk/workers server-sdk/debugging client-sdk/overview client-sdk/messages client-sdk/streaming client-sdk/execution-blocks client-sdk/socket-transport client-sdk/http-transport client-sdk/structured-output client-sdk/file-uploads client-sdk/error-handling client-sdk/client-tools protocol/overview protocol/input-resources protocol/triggers protocol/tools protocol/skills protocol/handlers protocol/agent-config protocol/provider-options protocol/skills-advanced protocol/types protocol/workers api-reference/overview api-reference/sessions api-reference/agents examples/overview examples/nextjs-chat examples/socket-chat migration/v1-to-v2 ``` ## Source Code The Octavus JavaScript SDK is open source: - **Repository**: https://github.com/octavus-ai/agent-sdk - **Packages**: https://github.com/octavus-ai/agent-sdk/tree/main/packages - **Documentation Source**: https://github.com/octavus-ai/agent-sdk/tree/main/packages/docs - **Contributing**: https://github.com/octavus-ai/agent-sdk/blob/main/CONTRIBUTING.md