Skip to content
API Reference/
/
ai_mentor_orgs_users_reco...

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_recently_accessed_mentors_list

Request

Endpoint for listing most recently accessed mentors.

Accessible to students and admins.

Returns:

200: List of most recently accessed mentors.

400: When request is not valid.

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

Responses

Bodyapplication/jsonArray [
idinteger or nullread-onlyrequired
unique_idstring or null(uuid)read-onlyrequired
slugstring or nullread-onlyrequired
namestring or nullread-onlyrequired
descriptionstring or nullread-onlyrequired
recently_accessed_atstring or nullread-onlyrequired
platform_keystring or nullread-onlyrequired
last_accessed_bystring or nullread-onlyrequired
]
Response
application/json
[
  [
    { … },
    { … },
    { … }
  ]
]

ai_mentor_orgs_users_recommend_courses_retrieve

Request

Retrieve recommended courses for a specific user.

Args: request: The HTTP request containing query parameters. org: The organization/tenant identifier. user_id: The ID of the user to get recommendations for.

Returns: Response: A list of recommended courses.

Raises: BadRequest: If the query parameters are invalid. NotFound: If the OpenAI API key for the tenant is not found. TooManyRequests: If rate limits are exceeded. ServerError: If there's an error processing the AI response.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Query
include_learner_skillsboolean

Include available learner skills for search

Default true
include_main_coursesboolean

Include courses from the main tenant

Default true
rank_by_difficultyboolean

Rank by course difficulty

Default false
return_course_databoolean

Return course data

Default false
return_numberinteger

Number of courses to return

search_termsstringnon-empty

Terms to be searched

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/recommend-courses/?include_learner_skills=true&include_main_courses=true&rank_by_difficulty=false&return_course_data=false&return_number=0&search_terms=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
coursesArray of objectsrequired
Response
application/json
{
  "courses": [
    { … },
    { … }
  ]
}

ai_mentor_orgs_users_recommend_courses_block_retrieve

Request

Retrieve recommended course blocks for a specific user.

Args: request: The HTTP request containing query parameters. org: The organization/tenant identifier. user_id: The ID of the user to get recommendations for.

Returns: Response: A list of recommended course blocks.

Raises: BadRequest: If the query parameters are invalid.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Query
include_learner_skillsboolean

Include available learner skills for search

Default true
include_main_coursesboolean

Include courses from the main tenant

Default true
rank_by_difficultyboolean

Rank by course difficulty

Default false
return_course_databoolean

Return course data

Default false
return_numberinteger

Number of courses to return

search_termsstringnon-empty

Terms to be searched

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/recommend-courses-block/?include_learner_skills=true&include_main_courses=true&rank_by_difficulty=false&return_course_data=false&return_number=0&search_terms=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
blocksArray of objectsrequired
Response
application/json
{
  "blocks": [
    { … },
    { … }
  ]
}

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