Skip to main content

API Reference

Complete API documentation for Radium. This reference covers all public APIs for extending and integrating with Radium.

Rust API Documentation​

The primary Radium API is written in Rust. Full Rust API documentation is available:

  • Rust API Docs - Complete Rust API documentation (generated from code)

Core APIs​

Context Cache API​

  • Context Cache API - Context caching and retrieval API
    • Cache management
    • Context retrieval
    • Cache invalidation

Extension System API​

The extension system provides APIs for creating, managing, and integrating extensions.

  • Extension API Reference - Complete extension system API
    • Extension manifest
    • Extension manager
    • Discovery API
    • Marketplace API
    • Signing API

Extension Types​

  • ExtensionManifest: Manifest parsing and validation
  • ExtensionManager: Installation and management
  • ExtensionDiscovery: Discovery and search
  • ExtensionMarketplace: Marketplace integration

Hooks API​

Native and WASM hooks for customizing agent behavior.

MCP Integration API​

Model Context Protocol integration for external tools and services.

Agent System API​

Agent Configuration​

Agent Execution​

  • Agent execution API (via CLI/TUI)
  • Agent orchestration API
  • Agent memory API

Orchestration API​

Intelligent task routing and agent coordination.

Planning API​

Autonomous planning and workflow generation.

Policy Engine API​

Fine-grained tool execution control.

Memory & Context API​

Plan-scoped memory and context management.

Self-Hosted Models API​

Integration with self-hosted AI models.

Monitoring API​

Agent monitoring and analytics.

Session Analytics API​

Track costs, performance, and optimize agent sessions.

CLI API​

Command-line interface for all operations.

gRPC API​

Radium uses gRPC for internal communication between components.

Core Services​

  • AgentService: Agent execution and management
  • OrchestrationService: Task routing and coordination
  • PlanningService: Plan generation and execution
  • MemoryService: Memory storage and retrieval
  • ContextService: Context gathering and management

Protocol Buffers​

Protocol buffer definitions are in crates/radium-core/proto/.

TypeScript/JavaScript API​

TypeScript packages for web and desktop applications.

  • packages/api-client: TypeScript API client
  • packages/shared-types: Shared TypeScript types
  • packages/state: State management
  • packages/ui: UI components

Future APIs​

Component Foundry API​

APIs for the Component Foundry Pattern (planned).

  • Component creation
  • Component validation
  • Component composition
  • Component versioning

Status: 📋 Planned Learn more: Roadmap: Component Foundry

Global Component Graph API​

APIs for component discovery and composition (planned).

  • Component search
  • Component discovery
  • Composition engine
  • Relationship tracking

Status: 📋 Planned Learn more: Roadmap: Global Component Graph

KOR Protocol API​

KOR protocol APIs for component exchange (planned).

  • Component publishing
  • Component retrieval
  • Marketplace integration
  • Economic models

Status: 📋 Planned Learn more: Roadmap: Protocol Specifications

API Versioning​

Radium APIs follow semantic versioning:

  • Major versions: Breaking changes
  • Minor versions: New features, backward compatible
  • Patch versions: Bug fixes, backward compatible

API Stability​

Stable APIs​

  • Agent configuration format
  • Extension manifest format
  • CLI command interface
  • gRPC service definitions

Experimental APIs​

  • Component Foundry APIs
  • Global Component Graph APIs
  • KOR Protocol APIs

Getting Help​

Next Steps​

Need help? Check the Developer Guide or open an issue.