Skip to content

ibl-data-manager (3.59.0-ai-plus)

API for iblai

Download OpenAPI description
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_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 anyrequired
Response
application/json
{ "blocks": [ {}, {} ] }

ai_mentor_orgs_users_resources_web_create

Request

Search for web resources based on a query.

Args: request: The HTTP request containing the search query. org: The organization/tenant identifier. user_id: The ID of the user making the request.

Returns: Response: A list of web resources matching the query.

Raises: ValidationError: If the search fails or returns no results.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Bodyrequired
querystringrequired
curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/resources/web/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "query": "ibl education"
  }'

Responses

Bodyapplication/jsonArray [
contentstringrequired
titlestringrequired
imageUrlstring or null
sourcestring
Default ""
metadataany or null
cardobject(WebResourceCard)
]
Response
application/json
[ [ {} ] ]

ai_mentor_orgs_users_safety_logs_list

Request

Endpoint to view and delete Safety System Logs for a tenant.

These can be filtered by username, platform_key and mentor id

A search query can be conducted to search through the prompts and reason for the moderation catch event.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Query
mentorinteger
orderingstring

Which field to use when ordering the results.

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

platform_keystring
searchstring

A search term.

target_systemstring
  • Safety System - Safety System
  • Moderation System - Moderation System
Enum"Moderation System""Safety System"
usernamestring
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/safety-logs/?mentor=0&ordering=string&page=0&page_size=0&platform_key=string&search=string&target_system=Moderation+System&username=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
countintegerrequired
Example: 123
nextstring or null(uri)
Example: "http://api.example.org/accounts/?page=4"
previousstring or null(uri)
Example: "http://api.example.org/accounts/?page=2"
resultsArray of objects(ModerationLog)required
results[].​idintegerread-onlyrequired
results[].​usernamestring<= 200 characters
results[].​platform_keystring<= 200 charactersrequired
results[].​mentorintegerrequired
results[].​promptstringrequired
results[].​reasonstringrequired
results[].​target_systemstring(TargetSystemEnum)
  • Safety System - Safety System
  • Moderation System - Moderation System
Enum"Safety System""Moderation System"
results[].​date_createdstring(date-time)read-onlyrequired
Response
application/json
{ "count": 123, "next": "http://api.example.org/accounts/?page=4", "previous": "http://api.example.org/accounts/?page=2", "results": [ {} ] }

ai-prompt

Operations

career

Operations

catalog

Operations

core

Operations

credentials

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

Operations