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
    • Concepts
      • Task Server
      • Broker
      • Checkpoint DB
      • Memory
      • Conversation History
    • How Tos
      • Update the AI Agent
      • Delete the AI Agent
    • Toolkit
      • SQL Runner
      • Kubernetes Job
    • API Documentation
    • Memory API Documentation
  • 💡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

Memory API Documentation

PreviousAPI DocumentationNextOverview

Last updated 15 days ago

Was this helpful?

Store Memory

Retrieve Memory

Update Memory

Delete Memory

List Collections

Get Collection Info

List Collections

get
Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/memory/collections'
200
{
  "status": "text",
  "message": "text",
  "data": {}
}

Successful Response

Get Collection Info

get
Path parameters
collection_namestringrequired
Responses
application/json
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/memory/collections/{collection_name}'
200
422
{
  "status": "text",
  "message": "text",
  "data": {}
}

Successful Response

  • Store Memory
  • POSTStore Memory
  • Retrieve Memory
  • GETRetrieve Memory
  • Update Memory
  • PATCHUpdate Memory
  • Delete Memory
  • DELETEDelete Memory
  • List Collections
  • GETList Collections
  • Get Collection Info
  • GETGet Collection Info

Store Memory

post
Body
collection_namestringrequired
textstringrequired
metadataany ofoptional

Responses
application/json
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url '/memory' \
  --header 'Content-Type: application/json' \
  --data '{
    "collection_name": "text",
    "text": "text",
    "metadata": {}
  }'
200
422
{
  "status": "text",
  "message": "text",
  "data": {}
}

Successful Response

Retrieve Memory

get
Body
collection_namestringrequired
querystringrequired
top_kany of · default: 5optional

Responses
application/json
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/memory' \
  --header 'Content-Type: application/json' \
  --data '{
    "collection_name": "text",
    "query": "text",
    "top_k": 1
  }'
200
422
{
  "status": "text",
  "message": "text",
  "data": {}
}

Successful Response

Update Memory

patch
Body
collection_namestringrequired
doc_idstringrequired
textstringrequired
metadataany ofoptional

Responses
application/json
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request PATCH \
  --url '/memory' \
  --header 'Content-Type: application/json' \
  --data '{
    "collection_name": "text",
    "doc_id": "text",
    "text": "text",
    "metadata": {}
  }'
200
422
{
  "status": "text",
  "message": "text",
  "data": {}
}

Successful Response

Delete Memory

delete
Body
collection_namestringrequired
doc_idstringrequired
Responses
application/json
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request DELETE \
  --url '/memory' \
  --header 'Content-Type: application/json' \
  --data '{
    "collection_name": "text",
    "doc_id": "text"
  }'
200
422
{
  "status": "text",
  "message": "text",
  "data": {}
}

Successful Response