ibl-data-manager (3.59.0-ai-plus)
API for iblai
Request
Update an existing custom instruction for a user.
Args: request: The HTTP request containing the updated custom instruction data. org: The organization/tenant identifier. user_id: The ID of the user to update custom instructions for.
Returns: Response: The updated custom instruction.
Raises: BadRequest: If the provided data is invalid. NotFound: If no custom instruction exists for the user.
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/custom-instruction/
https://base.manager.iblai.app/api/ai-mentor/orgs/{org}/users/{user_id}/custom-instruction/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/custom-instruction/' \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"content": "Always explain concepts in simple terms with examples and analogies."
}'{ "id": 1, "username": "johndoe", "platform_key": "main", "content": "Always explain concepts in simple terms with examples and analogies.", "created_at": "2023-01-01T12:00:00Z", "updated_at": "2023-01-02T14:30:00Z" }
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/downloads/tasks/{task_id}/
https://base.manager.iblai.app/api/ai-mentor/orgs/{org}/users/{user_id}/downloads/tasks/{task_id}/
- 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-mentor/orgs/{org}/users/{user_id}/downloads/tasks/{task_id}/?to_csv=false' \
-H 'Authorization: YOUR_API_KEY_HERE'{ "state": "task_not_ready" }
Request
Endpoints to fetch and delete Edx stored Memory information stored for a user and a corresponding edx course they have interracted with. This information is passed to the corresponding mentor so the mentor has context information about the course and unit that the user last interracted with.
There can be only one UserEdxMemory instance per student and course_id.
Url Args: org (str): The organization's platform key. user_id (str): The username identifier of the individual.
Returns:
200: A paginated list of UserEdxMemory objects
Examples:
List all memories GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/
Request: None Response: { "count": 0, "next": null, "previous": null, "results": [{ "student": 1, "course_id": "course-v1:main+CARBON+2024_Fall", "data": {}, "date_created": "2024-06-25T15:30:26.257140", "last_modified": "2024-06-25T15:30:26.257140" }] }
Get a single UserEdxMemory object GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/1/
Request: None Response: { "student": 1, "course_id": "course-v1:main+CARBON+2024_Fall", "data": {}, "date_created": "2024-06-25T15:30:26.257140", "last_modified": "2024-06-25T15:30:26.257140" }
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/edx-memory/
https://base.manager.iblai.app/api/ai-mentor/orgs/{org}/users/{user_id}/edx-memory/
- 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-mentor/orgs/{org}/users/{user_id}/edx-memory/?course_id=string&ordering=string&page=0&page_size=0&student=2147483647&username=string' \
-H 'Authorization: YOUR_API_KEY_HERE'{ "count": 123, "next": "http://api.example.org/accounts/?page=4", "previous": "http://api.example.org/accounts/?page=2", "results": [ { … } ] }