Skip to main content

Interface: AgentOSConfig

Defined in: packages/agentos/src/api/AgentOS.ts:298

AgentOSConfig

Description​

Defines the comprehensive configuration structure required to initialize and operate the AgentOS service. This configuration object aggregates settings for all major sub-components and dependencies of the AgentOS platform.

Properties​

authService​

authService: IAuthService

Defined in: packages/agentos/src/api/AgentOS.ts:345

An instance of the authentication service, conforming to IAuthService.

conversationManagerConfig​

conversationManagerConfig: ConversationManagerConfig

Defined in: packages/agentos/src/api/AgentOS.ts:320

Configuration for the ConversationManager.

defaultPersonaId​

defaultPersonaId: string

Defined in: packages/agentos/src/api/AgentOS.ts:326

The default Persona ID to use if none is specified in an interaction.

extensionManifest?​

optional extensionManifest: ExtensionManifest

Defined in: packages/agentos/src/api/AgentOS.ts:362

Optional extension manifest describing packs to load.

extensionOverrides?​

optional extensionOverrides: ExtensionOverrides

Defined in: packages/agentos/src/api/AgentOS.ts:364

Declarative overrides applied after packs are loaded.

extensionSecrets?​

optional extensionSecrets: Record<string, string>

Defined in: packages/agentos/src/api/AgentOS.ts:351

Optional map of secretId -> value for extension/tool credentials.

gmiManagerConfig​

gmiManagerConfig: GMIManagerConfig

Defined in: packages/agentos/src/api/AgentOS.ts:300

Configuration for the GMIManager.

guardrailService?​

optional guardrailService: IGuardrailService

Defined in: packages/agentos/src/api/AgentOS.ts:349

Optional guardrail service implementation used for policy enforcement.

languageConfig?​

optional languageConfig: AgentOSLanguageConfig

Defined in: packages/agentos/src/api/AgentOS.ts:397

Optional multilingual configuration enabling detection, negotiation, translation.

longTermMemoryRetriever?​

optional longTermMemoryRetriever: ILongTermMemoryRetriever

Defined in: packages/agentos/src/api/AgentOS.ts:312

Optional retriever for injecting durable long-term memory context into prompts (e.g. user/org/persona memories stored in a RAG/KG).

modelProviderManagerConfig​

modelProviderManagerConfig: AIModelProviderManagerConfig

Defined in: packages/agentos/src/api/AgentOS.ts:324

Configuration for the AIModelProviderManager.

orchestratorConfig​

orchestratorConfig: AgentOSOrchestratorConfig

Defined in: packages/agentos/src/api/AgentOS.ts:302

Configuration for the AgentOSOrchestrator.

personaLoader?​

optional personaLoader: IPersonaLoader

Defined in: packages/agentos/src/api/AgentOS.ts:399

Optional custom persona loader (useful for browser/local runtimes).

prisma​

prisma: PrismaClient

Defined in: packages/agentos/src/api/AgentOS.ts:343

An instance of the Prisma client for database interactions.

Optional when storageAdapter is provided:

  • If storageAdapter is provided, Prisma is only used for server-side features (auth, subscriptions).
  • If storageAdapter is omitted, Prisma is required for all database operations.

Client-side usage:

const storage = await createAgentOSStorage({ platform: 'web' });
await agentos.initialize({
  storageAdapter: storage.getAdapter(),
  prisma: mockPrisma,  // Stub for compatibility (can be minimal mock)
  // ...
});

promptEngineConfig​

promptEngineConfig: PromptEngineConfig

Defined in: packages/agentos/src/api/AgentOS.ts:314

Configuration for the PromptEngine.

registryConfig?​

optional registryConfig: MultiRegistryConfig

Defined in: packages/agentos/src/api/AgentOS.ts:391

Optional registry configuration for loading extensions and personas from custom sources. Allows self-hosted registries and custom git repositories.

Example​

registryConfig: {
  registries: {
    'extensions': {
      type: 'github',
      location: 'your-org/your-extensions',
      branch: 'main',
    },
    'personas': {
      type: 'github',
      location: 'your-org/your-personas',
      branch: 'main',
    }
  },
  defaultRegistries: {
    tool: 'extensions',
    persona: 'personas',
  }
}

rollingSummaryMemorySink?​

optional rollingSummaryMemorySink: IRollingSummaryMemorySink

Defined in: packages/agentos/src/api/AgentOS.ts:307

Optional sink for persisting rolling-memory outputs (summary_markdown + memory_json) into an external long-term store (RAG / knowledge graph / database).

storageAdapter?​

optional storageAdapter: any

Defined in: packages/agentos/src/api/AgentOS.ts:427

Optional cross-platform storage adapter for client-side persistence. Enables fully offline AgentOS in browsers (IndexedDB), desktop (SQLite), mobile (Capacitor).

Platform Support:

  • Web: IndexedDB (recommended) or sql.js
  • Electron: better-sqlite3 (native) or sql.js (fallback)
  • Capacitor: @capacitor-community/sqlite (native) or IndexedDB
  • Node: better-sqlite3 or PostgreSQL

Usage:

import { createAgentOSStorage } from '@framers/sql-storage-adapter/agentos';

const storage = await createAgentOSStorage({ platform: 'auto' });

await agentos.initialize({
  storageAdapter: storage.getAdapter(),
  // ... other config
});

Graceful Degradation:

  • If omitted, AgentOS falls back to Prisma (server-side only).
  • If provided, AgentOS uses storageAdapter for conversations, Prisma only for auth/subscriptions.
  • Recommended: Always provide storageAdapter for cross-platform compatibility.

streamingManagerConfig​

streamingManagerConfig: StreamingManagerConfig

Defined in: packages/agentos/src/api/AgentOS.ts:322

Configuration for the StreamingManager.

subscriptionService​

subscriptionService: ISubscriptionService

Defined in: packages/agentos/src/api/AgentOS.ts:347

An instance of the subscription service, conforming to ISubscriptionService.

toolOrchestratorConfig​

toolOrchestratorConfig: ToolOrchestratorConfig

Defined in: packages/agentos/src/api/AgentOS.ts:316

Configuration for the ToolOrchestrator.

toolPermissionManagerConfig​

toolPermissionManagerConfig: ToolPermissionManagerConfig

Defined in: packages/agentos/src/api/AgentOS.ts:318

Configuration for the ToolPermissionManager.

utilityAIService?​

optional utilityAIService: IUtilityAI & IPromptEngineUtilityAI

Defined in: packages/agentos/src/api/AgentOS.ts:360

Optional. An instance of a utility AI service. This service should conform to IUtilityAI for general utility tasks. If the PromptEngine is used and requires specific utility functions (like advanced summarization for prompt construction), this service must also fulfill the contract of IPromptEngineUtilityAI. It's recommended that the concrete class for this service implements both interfaces if needed.

workflowEngineConfig?​

optional workflowEngineConfig: WorkflowEngineConfig

Defined in: packages/agentos/src/api/AgentOS.ts:393

Optional workflow engine configuration.

workflowStore?​

optional workflowStore: IWorkflowStore

Defined in: packages/agentos/src/api/AgentOS.ts:395

Optional workflow store implementation. Defaults to the in-memory store if omitted.