ibl-data-manager (3.59.0-ai-plus)
API for iblai
Request
Create a new catalog item memory entry for a user.
Args: request: The HTTP request containing the catalog item memory data. org: The organization/tenant identifier. user_id: The ID of the user to create catalog item memory for.
Returns: Response: The created catalog item memory entry.
Raises: BadRequest: If the provided data is invalid.
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/ai-prompt/orgs/{org}/users/{user_id}/memory/
https://base.manager.iblai.app/api/ai-prompt/orgs/{org}/users/{user_id}/memory/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://docs.ibl.ai/_mock/apis/ibl/api/ai-prompt/orgs/{org}/users/{user_id}/memory/' \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"student": "johndoe",
"platform": "main",
"catalog_item": "course-v1:edX+DemoX+Demo_Course",
"lessons": {
"completed": [
"lesson1",
"lesson2"
],
"in_progress": [
"lesson3"
]
},
"next_steps": {
"recommended": [
"lesson4",
"lesson5"
]
}
}'
{ "id": 1, "student": "johndoe", "platform": "main", "catalog_item": "course-v1:edX+DemoX+Demo_Course", "lessons": { "completed": [ … ], "in_progress": [ … ] }, "next_steps": { "recommended": [ … ] } }
Request
Delete all catalog item memory for a specific user.
Args: request: The HTTP request. org: The organization/tenant identifier. user_id: The ID of the user to delete catalog item memory for.
Returns: Response: A success message if the memory was deleted.
Raises: NotFound: If no catalog item memory exists for the user.
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/ai-prompt/orgs/{org}/users/{user_id}/memory/
https://base.manager.iblai.app/api/ai-prompt/orgs/{org}/users/{user_id}/memory/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://docs.ibl.ai/_mock/apis/ibl/api/ai-prompt/orgs/{org}/users/{user_id}/memory/' \
-H 'Authorization: YOUR_API_KEY_HERE'
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/ai-prompt/orgs/{org}/users/{user_id}/memory-context/
https://base.manager.iblai.app/api/ai-prompt/orgs/{org}/users/{user_id}/memory-context/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.ibl.ai/_mock/apis/ibl/api/ai-prompt/orgs/{org}/users/{user_id}/memory-context/' \
-H 'Authorization: YOUR_API_KEY_HERE'
{ "username": "johndoe", "platform_key": "main", "extra_data": null, "use_reported_skills": false, "use_desired_skills": false, "use_credentials": false, "use_enrolled_courses": false, "use_time_spent": false, "use_completed_courses": false, "use_completed_programs": false }