ibl-data-manager (3.59.0-ai-plus)
API for iblai
Request
Create a pinned message for a user session.
Args: request: The HTTP request containing session details. org: Organization key identifier. user_id: The username of the student.
Returns: Response: Status 201 on success.
Raises: NotFound: If the student does not exist. ValidationError: If request data is invalid.
- 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}/pin-message/
https://base.manager.iblai.app/api/ai-mentor/orgs/{org}/users/{user_id}/pin-message/
- 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-mentor/orgs/{org}/users/{user_id}/pin-message/' \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"session_id": "550e8400-e29b-41d4-a716-446655440000"
}'{ "session_id": "550e8400-e29b-41d4-a716-446655440000", "username": "user", "platform": "https://base.manager.iblai.app/api/core/platform/1" }
Request
Delete a pinned message for a user.
Args: request: The HTTP request containing session details. org: Organization key identifier. user_id: The username of the student.
Returns: Response: Status 204 on success.
Raises: NotFound: If the student or pinned message does not exist. ValidationError: If request data is invalid.
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/pin-message/
https://base.manager.iblai.app/api/ai-mentor/orgs/{org}/users/{user_id}/pin-message/
- 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-mentor/orgs/{org}/users/{user_id}/pin-message/' \
-H 'Authorization: YOUR_API_KEY_HERE'{ "property1": null, "property2": null }
Request
Endpoints for viewing jobs and their status A job run refers to a task with steps that an agent is going to undertake. You can filter job runs by their status. Note that for a single user and a specified session, at most only one JobRun instance is active at any point in time.
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/planned-jobs/
https://base.manager.iblai.app/api/ai-mentor/orgs/{org}/users/{user_id}/planned-jobs/
- 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}/planned-jobs/?active=true&ordering=string&page=0&page_size=0&search=string&session=497f6eca-6276-4993-bfeb-53cbbbba6f08' \
-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": [ { … } ] }