Canso - ML Platform
  • 👋Introduction
  • 🏛️Canso Architecture
  • 💻Getting Started
    • 🏁Overview
    • 🌌Provison K8s Clusters
    • 🚢Install Canso Helm Charts
    • 🐍🔗 Canso Python Client & Web App
    • 📊Health Metrics for Features in the Data Plane
  • 💡Feature Store
    • Data Sources
      • Data Spans
    • Data Sinks
    • ML Features
      • Raw ML Batch Feature
      • Derived ML Batch Feature
      • Raw ML Streaming Feature
      • Custom User Defined Function
  • 💡AI Agents
    • Introduction
    • Getting Started
    • Quickstart
    • Use Cases
      • Fraud Analyst Agent
      • Agent with Memory
      • Memory command examples
    • Concepts
      • Task Server
      • Broker
      • Checkpoint DB
      • Conversation History
      • Memory
    • How Tos
      • Update the AI Agent
      • Delete the AI Agent
    • Toolkit
      • SQL Runner
      • Kubernetes Job
      • Text-to-SQL
    • API Documentation
      • Agent
      • Memory
  • 💡Risk
    • Overview
    • Workflows and Rules
    • Real Time Transaction Monitoring
    • API Documentation
  • 📝Guides
    • Registry
    • Dry Runs for Batch ML Features
    • Deployment
Powered by GitBook
On this page

Was this helpful?

  1. 💡AI Agents
  2. API Documentation

Memory

PreviousAgentNextOverview

Last updated 29 days ago

Was this helpful?

Store Memory

Retrieve Memory

Update Memory

Delete Memory

List Collections

Get Collection Info

Retrieve Memory

get
Query parameters
collection_namestringRequired
querystringRequired
top_kany ofOptionalDefault: 5
integerOptional
or
nullOptional
Header parameters
correlation-idstringRequired
Responses
get
GET /memory?collection_name=text&query=text HTTP/1.1
Host: 
correlation-id: text
Accept: */*

{
  "results": [
    {}
  ]
}
  • Store Memory
  • POSTStore Memory
  • Retrieve Memory
  • GETRetrieve Memory
  • Update Memory
  • PATCHUpdate Memory
  • Delete Memory
  • DELETEDelete Memory
  • List Collections
  • Get Collection Info

Store Memory

post
Header parameters
correlation-idstringRequired
Body
collection_namestringRequired
dataobjectRequired
Responses
post
POST /memory HTTP/1.1
Host: 
correlation-id: text
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "collection_name": "text",
  "data": {}
}
{
  "message": "text"
}

Update Memory

patch
Header parameters
correlation-idstringRequired
Body
collection_namestringRequired
dataobjectRequired
Responses
patch
PATCH /memory HTTP/1.1
Host: 
correlation-id: text
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "collection_name": "text",
  "data": {}
}
{
  "message": "text"
}

Delete Memory

delete
Header parameters
correlation-idstringRequired
Body
collection_namestringRequired
match_criteriaobjectRequired
Responses
delete
DELETE /memory HTTP/1.1
Host: 
correlation-id: text
Content-Type: application/json
Accept: */*
Content-Length: 46

{
  "collection_name": "text",
  "match_criteria": {}
}
{
  "message": "text"
}