Skip to content
API Reference/
/
ai_mentor_orgs_users_ment...

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_mentors_star_create

Request

Endpoint for starring a mentor.

Accessible to students and admins.

Returns:

200: Star status.

400: When request is not valid.

Security
PlatformApiKeyAuthentication
Path
mentorstringrequired
orgstringrequired
user_idstringrequired
curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/star/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
is_starredboolean
updated_atstringread-onlyrequired
mentorstringread-onlyrequired
studentstringread-onlyrequired
recently_accessed_atstring or nullread-onlyrequired
Response
application/json
{
  "is_starred": false,
  "updated_at": "2025-01-11T14:00:00.544398+00:00",
  "mentor": "mentor0",
  "student": "student0",
  "recently_accessed_at": "2025-01-16T14:32:08.691442+00:00"
}

ai_mentor_orgs_users_mentors_summaries_retrieve

Request

GET /api/orgs/<platform_key>/users/<username>/mentors/<mentor_unique_id>/summaries/<summary_type>/

Endpoint to get mentor summary. The summary type can be user or general.

Sample response:

{"rating": 3.9, "summary": "The mentor had a good chat."}
Security
PlatformApiKeyAuthentication
Path
mentorstringrequired
orgstringrequired
summary_typestringrequired
user_idstringrequired
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/summaries/{summary_type}/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
ratingnumber or null(double)required
summarystring or nullrequired
tagsArray of stringsrequired
Response
application/json
{
  "rating": 3.9,
  "summary": "The mentor had a good chat."
}

ai_mentor_orgs_users_mentors_unstar_create

Request

Remove a mentor from a user's starred list.

Args: request: The HTTP request. org: The organization/tenant identifier. user_id: The ID of the user unstarring the mentor. mentor: The identifier of the mentor to unstar.

Returns: Response: The updated star status of the mentor.

Raises: NotFound: If the specified mentor or student does not exist. BadRequest: If the request is invalid.

Security
PlatformApiKeyAuthentication
Path
mentorstringrequired
orgstringrequired
user_idstringrequired
curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/unstar/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
is_starredboolean
updated_atstringread-onlyrequired
mentorstringread-onlyrequired
studentstringread-onlyrequired
recently_accessed_atstring or nullread-onlyrequired
Response
application/json
{
  "is_starred": false,
  "updated_at": "2025-01-11T14:00:00.544398+00:00",
  "mentor": "mentor0",
  "student": "student0",
  "recently_accessed_at": "2025-01-16T14:32:08.691442+00:00"
}

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