OpenAssistantAPI

User API

Memories

User memory store

GET/memories

List memories for current user

Query parameters

pageinteger
perPageinteger
limitinteger
tagsstringComma-separated tag filter
typestring
searchstring
scopestring
contactEmailstringShorthand for tags=contact:<email>
companyIdstringShorthand for tags=company:<id>

Responses

200Paginated memory list
ok reqenumtrue
memories reqobject[]
id reqstring
account reqstring
user reqstring
kindenumunstructuredstructured
resourceTypestring | null
tags reqstring[]
contentstring | null
dataobject | null
source reqenumsystemuser
scopeenumuserteam
visibilityenumauthor_onlycoordinatorsall
audienceenumuserinternal
authoredBystring | null
assistantstring | null
teamstring | null
startDatestring | null
endDatestring | null
isActive reqboolean
isExpired reqboolean
metadataobject
createdAt reqstring
updatedAt reqstring
pageinteger
perPageinteger
totalinteger

Request

curl 'https://app.openassistant.us/api/memories' \
  -H "Authorization: Bearer ak_live_..."

Response

{
  "ok": true,
  "memories": [
    {
      "id": "string",
      "account": "string",
      "user": "string",
      "tags": [
        "string"
      ],
      "source": "system",
      "isActive": true
    }
  ]
}
POST/memories

Create a new memory

Request body

content reqstring
tagsstring[]
sourceenumsystemuser
scopeenumuserteam
teamstring
startDatestring
endDatestring
metadataobject

Responses

201Created memory
ok reqenumtrue
memory reqobject
id reqstring
account reqstring
user reqstring
kindenumunstructuredstructured
resourceTypestring | null
tags reqstring[]
contentstring | null
dataobject | null
source reqenumsystemuser
scopeenumuserteam
visibilityenumauthor_onlycoordinatorsall
audienceenumuserinternal
authoredBystring | null
assistantstring | null
teamstring | null
startDatestring | null
endDatestring | null
isActive reqboolean
isExpired reqboolean
metadataobject
createdAt reqstring
updatedAt reqstring
400Bad request
status reqinteger
error_codestring
error reqstring

Request

curl 'https://app.openassistant.us/api/memories' \
  -X POST \
  -H "Authorization: Bearer ak_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "content": "string"
}'

Response

{
  "ok": true,
  "memory": {
    "id": "string",
    "account": "string",
    "user": "string",
    "tags": [
      "string"
    ],
    "source": "system",
    "isActive": true
  }
}
GET/memories/{memoryId}

Get a specific memory

Path parameters

memoryId reqstring

Responses

200Memory
ok reqenumtrue
memory reqobject
id reqstring
account reqstring
user reqstring
kindenumunstructuredstructured
resourceTypestring | null
tags reqstring[]
contentstring | null
dataobject | null
source reqenumsystemuser
scopeenumuserteam
visibilityenumauthor_onlycoordinatorsall
audienceenumuserinternal
authoredBystring | null
assistantstring | null
teamstring | null
startDatestring | null
endDatestring | null
isActive reqboolean
isExpired reqboolean
metadataobject
createdAt reqstring
updatedAt reqstring
404Not found
status reqinteger
error_codestring
error reqstring

Request

curl 'https://app.openassistant.us/api/memories/<memoryId>' \
  -H "Authorization: Bearer ak_live_..."

Response

{
  "ok": true,
  "memory": {
    "id": "string",
    "account": "string",
    "user": "string",
    "tags": [
      "string"
    ],
    "source": "system",
    "isActive": true
  }
}
PUT/memories/{memoryId}

Update a memory

Path parameters

memoryId reqstring

Request body

contentstring
tagsstring[]
scopeenumuserteam
teamstring | null
startDatestring | null
endDatestring | null
metadataobject

Responses

200Updated memory
ok reqenumtrue
memory reqobject
id reqstring
account reqstring
user reqstring
kindenumunstructuredstructured
resourceTypestring | null
tags reqstring[]
contentstring | null
dataobject | null
source reqenumsystemuser
scopeenumuserteam
visibilityenumauthor_onlycoordinatorsall
audienceenumuserinternal
authoredBystring | null
assistantstring | null
teamstring | null
startDatestring | null
endDatestring | null
isActive reqboolean
isExpired reqboolean
metadataobject
createdAt reqstring
updatedAt reqstring

Request

curl 'https://app.openassistant.us/api/memories/<memoryId>' \
  -X PUT \
  -H "Authorization: Bearer ak_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "content": "string",
  "tags": [
    "string"
  ],
  "scope": "user",
  "team": "string"
}'

Response

{
  "ok": true,
  "memory": {
    "id": "string",
    "account": "string",
    "user": "string",
    "tags": [
      "string"
    ],
    "source": "system",
    "isActive": true
  }
}
DELETE/memories/{memoryId}

Delete a memory

Path parameters

memoryId reqstring

Responses

200Deleted
ok reqenumtrue
memory reqobject
id reqstring
deletedboolean
messagestring

Request

curl 'https://app.openassistant.us/api/memories/<memoryId>' \
  -X DELETE \
  -H "Authorization: Bearer ak_live_..."

Response

{
  "ok": true,
  "memory": {
    "id": "string"
  }
}