Memory

Store Memory

Store Memory

post
Header parameters
correlation-idstringRequired
Body
collection_namestringRequired
dataobject · DataRequired
Responses
200

Successful Response

application/json
post
/memory
POST /memory HTTP/1.1
Host: 
correlation-id: text
Content-Type: application/json
Accept: */*
Content-Length: 36

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

Retrieve Memory

Retrieve Memory

get
Query parameters
collection_namestringRequired
querystringRequired
top_kany ofOptionalDefault: 5
integerOptional
or
nullOptional
Header parameters
correlation-idstringRequired
Responses
200

Successful Response

application/json
get
/memory
GET /memory?collection_name=text&query=text HTTP/1.1
Host: 
correlation-id: text
Accept: */*

{
  "results": [
    {}
  ]
}

Update Memory

Update Memory

patch
Header parameters
correlation-idstringRequired
Body
collection_namestringRequired
dataobject · DataRequired
Responses
200

Successful Response

application/json
patch
/memory
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 Memory

delete
Header parameters
correlation-idstringRequired
Body
collection_namestringRequired
match_criteriaobject · MatchCriteriaRequired
Responses
200

Successful Response

application/json
delete
/memory
DELETE /memory HTTP/1.1
Host: 
correlation-id: text
Content-Type: application/json
Accept: */*
Content-Length: 46

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

List Collections

Get Collection Info

PreviousAgentNextOverview

Last updated

Was this helpful?