Skip to content
API Reference/
/
ai_mentor_orgs_users_memo...

ibl-data-manager (4.84.1-ai-plus)

API for iblai

Download OpenAPI description
ibl.json
ibl.yaml
Languages
Servers
Mock server
https://docs.ibl.ai/_mock/apis/ibl/
https://base.manager.iblai.app/

ai-account

Operations

ai-analytics

Operations

ai-bot

Operations

ai-finetuning

Operations

ai-index

Operations

ai-marketing

Operations

ai-media

Operations

ai-mentor

Operations

ai_mentor_orgs_users_memory_filter_retrieve

Request

Use the this endpoint to get all memory categories:

GET /api/ai-mentor/orgs/main/users/your-user/memory-filter/

Sample response

{
  "categories": [
    "lessons_learned",
    "knowledge_gaps",
    "help_requests",
    "personal_information"
  ],
  "users": [
    {
      "username": "animashaun1vie",
      "email": "animashaun1vie@gmail.com",
      "lti_email": ""
    }
  ]
}
Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/memory-filter/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

No response body

ai_mentor_orgs_users_memory_retrieve

Request

Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent

Security
PlatformApiKeyAuthentication
Path
memory_unique_id_or_namestringrequired
orgstringrequired
user_idstringrequired
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/memory/{memory_unique_id_or_name}/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
modestringread-onlyrequired
namestring
emailstring or nullread-onlyrequired
unique_idstring(uuid)
usernamestring or nullread-onlyrequired
platformstring or nullread-onlyrequired
mentorstring or nullread-onlyrequired
session_idstring or nullread-onlyrequired
catalog_item_typestring or nullread-onlyrequired
catalog_item_idstring or nullread-onlyrequired
entriesArray of objects(UserMemoryEntry)required
entries[].​unique_idstring(uuid)
entries[].​keystringrequired
entries[].​valuestring or null
entries[].​inserted_atstringread-onlyrequired
entries[].​updated_atstringread-onlyrequired
entries[].​expires_atstring or nullread-onlyrequired
entries[].​categorystring or nullread-onlyrequired
inserted_atstringread-onlyrequired
updated_atstringread-onlyrequired
is_auto_generatedboolean
categorystring or null
Response
application/json
{
  "mode": "guided",
  "name": "user memory 1",
  "unique_id": "c0901cee-3c03-4bad-b445-07847bb6969e",
  "username": "myuser",
  "platform": "main",
  "mentor": "2126ee0f-17ac-433e-8f40-abbd3a918ea5",
  "session_id": "72515328-24fa-423f-9c63-570223d31787",
  "catalog_item_type": "course",
  "catalog_item_id": "course-v1:abcdf",
  "entries": [
    { … },
    { … }
  ],
  "inserted_at": "2024-03-10T12:00:00Z",
  "updated_at": "2024-03-11T14:30:00Z",
  "is_auto_generated": false,
  "category": "important"
}

ai_mentor_orgs_users_memory_destroy

Request

Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent

Security
PlatformApiKeyAuthentication
Path
memory_unique_id_or_namestringrequired
orgstringrequired
user_idstringrequired
curl -i -X DELETE \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/memory/{memory_unique_id_or_name}/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Memory deleted successfully.

ai-prompt

Operations

analytics

Operations

career

Operations

catalog

Operations

core

Operations

credentials

Operations

custom-domains

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

Operations
Copyright © ibl.ai | support@iblai.zendesk.com