ibl-data-manager (3.59.0-ai-plus)
API for iblai
Request
Retrieve a specific evaluation report.
Args: request: The HTTP request. org: The organization/tenant identifier. user_id: The ID of the user making the request. mentor: The identifier of the mentor that was evaluated. report_id: The ID of the evaluation report to retrieve.
Returns: Response: The detailed evaluation report.
Raises: BadRequest: If the report does not exist, does not match the mentor, or is still being generated.
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/reports/{report_id}/mentor-eval-report/
https://base.manager.iblai.app/api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/reports/{report_id}/mentor-eval-report/
- 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}/mentors/{mentor}/reports/{report_id}/mentor-eval-report/' \
-H 'Authorization: YOUR_API_KEY_HERE'{ "id": 125, "mentor_eval": "(Mentor mentorAI|main, Question Set 5)", "mentor": "mentorAI - main", "conversation_ratings": [ { … }, { … } ], "overall_score": 95, "is_passed": true, "generated_at": "2024-12-03T14:17:17.725963Z" }
Request
Retrieve available scenarios for a specific mentor.
Args: request: The HTTP request. org: The organization/tenant identifier. user_id: The ID of the user making the request. mentor: The identifier of the mentor to retrieve scenarios for.
Returns: Response: The available scenarios for the mentor.
Raises: NotFound: If the specified mentor or scenarios do not exist.
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/scenarios/
https://base.manager.iblai.app/api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/scenarios/
- 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}/mentors/{mentor}/scenarios/'[ { "display": "Chat", "name": "chat", "prompts": [ … ] }, { "display": "Plan", "name": "plan", "prompts": [ … ] } ]
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/settings/
https://base.manager.iblai.app/api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/settings/
- 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}/mentors/{mentor}/settings/?department_id=0' \
-H 'Authorization: YOUR_API_KEY_HERE'viewable_by_tenant_admins- Viewable By Tenant Adminsviewable_by_tenant_students- Viewable By Tenant Studentsviewable_by_anyone- Viewable By Anyone
viewable_by_tenant_admins- Viewable By Tenant Adminsviewable_by_tenant_students- Viewable By Tenant Studentsviewable_by_anyone- Viewable By Anyone
{ "mentor": "mentor_123", "display_name": "John Doe", "profile_image": "https://example.com/image.jpg", "theme": "dark", "enable_image_generation": true }