AIOS Docs
  • Welcome
  • Getting Started
    • Installation
    • Quickstart
      • Use Terminal
      • Use WebUI
    • Environment Variables Configuration
  • AIOS Kernel
    • Overview
    • LLM Core(s)
      • LiteLLM Compatible Backend
      • vLLM Backend
      • Hugging Face Backend
      • LLM Routing
    • Scheduler
      • FIFOScheduler
      • RRScheduler
    • Context
    • Memory
      • Base Layer
      • Agentic Memory Operations
    • Storage
      • sto_mount
      • sto_create_file
      • sto_create_directory
      • sto_write
      • sto_retrieve
      • sto_rollback
      • sto_share
    • Tools
    • Access
    • Syscalls
    • Terminal
  • AIOS Agent
    • How to Use Agent
    • How to Develop Agents
      • Develop with Native SDK
      • Develop with AutoGen
      • Develop with Open-Interpreter
      • Develop with MetaGPT
    • How to Publish Agents
  • AIOS-Agent SDK
    • Overview
    • LLM Core API
      • llm_chat
      • llm_chat_with_json_output
      • llm_chat_with_tool_call_output
      • llm_call_tool
      • llm_operate_file
    • Memory API
      • create_memory
      • get_memory
      • update_memory
      • delete_memory
      • search_memories
      • create_agentic_memory
    • Storage API
      • mount
      • create_file
      • create_dir
      • write_file
      • retrieve_file
      • rollback_file
      • share_file
    • Tool API
      • How to Develop Tools
    • Access API
    • Post API
    • Agent API
  • Community
    • How to Contribute
Powered by GitBook
On this page
  1. AIOS-Agent SDK

Memory API

The Memory API provides a structured way to manage and retrieve agent memories through CRUD operations and semantic search capabilities. This documentation explains core functionality and usage patterns.

Core Concepts

  • Memory: A structured data object containing:

    • Content: Textual information

    • Metadata: Key-value pairs for organization

    • Unique memory ID

  • Operations: Create, Read, Update, Delete, and Semantic Search

  • Agent Context: Memories are stored per agent namespace

Functional Details

1. Standard Memory APIs

API
Parameters
Outputs
Use Case Example

create_memory

content, metadata

Memory ID

Storing meeting notes

read_memory

memory_id

Content + Metadata

Recalling specific events

update_memory

memory_id, content/metadata

Success status

Correcting outdated information

delete_memory

memory_id

Success status

GDPR compliance requests

search_memories

query, k (results count)

Ranked memory list

Finding related project memories

2. Agentic Memory APIs

API
Special Features
Cognitive Components
Autonomous Behaviors

create_agentic_memory

- Dynamic linking - Cognitive tagging

Activation levels Retention scores

Auto-clustering Context adaptation

Previousllm_operate_fileNextcreate_memory

Last updated 1 month ago