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_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_mentor_orgs_users_metadata_retrieve

Request

Retrieve metadata for a mentor.

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

Returns: Response: The mentor metadata.

Raises: NotFound: If no metadata exists for the specified mentor.

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}/metadata' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
metadataanyrequired
mentorstring
mentor_idinteger
Response
application/json
{ "metadata": { "specialty": "machine learning", "experience_level": "expert", "languages": [] }, "mentor_id": 123 }

ai_mentor_orgs_users_moderation_logs_list

Request

Endpoint to view and delete Moderation 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}/moderation-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