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_reports_mentor_eval_report_retrieve

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.

Security
PlatformApiKeyAuthentication
Path
mentorstringrequired
orgstringrequired
report_idintegerrequired
user_idstringrequired
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'

Responses

Bodyapplication/json
idintegerread-onlyrequired
mentor_evalstringread-onlyrequired
mentorstringread-onlyrequired
conversation_ratingsArray of objects(ConversationRating)read-onlyrequired
conversation_ratings[].​idintegerread-onlyrequired
conversation_ratings[].​full_conversation_textstringrequired
conversation_ratings[].​rating_textstring or null
conversation_ratings[].​scorenumber or null(double)
overall_scorenumber(double)read-onlyrequired
is_passedbooleanread-onlyrequired
generated_atstring(date-time)read-onlyrequired
Response
application/json
{
  "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"
}

ai_mentor_orgs_users_mentors_scenarios_retrieve

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.

Path
mentorstringrequired
orgstringrequired
user_idstringrequired
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/scenarios/'

Responses

Bodyapplication/json
displaystring or null
namestringrequired
promptsArray of objects(MentorScenarioPrompt)required
prompts[].​summarystringrequired
prompts[].​contentstringrequired
prompts[].​iconstring
Response
application/json
[
  {
    "display": "Chat",
    "name": "chat",
    "prompts": [ … ]
  },
  {
    "display": "Plan",
    "name": "plan",
    "prompts": [ … ]
  }
]

Retrieve Mentor Settings

Request

Fetch the settings of a mentor within an organization. Only accessible to tenant admins.

Security
PlatformApiKeyAuthentication
Path
mentorstringrequired
orgstringrequired
user_idstringrequired
Query
department_idinteger

Department to authorize users by

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'

Responses

Bodyapplication/json
idintegerread-onlyrequired
display_namestring or null<= 255 characters
profile_imagestring or null
initial_messagestring or null
suggested_messagestring or null
themestring(ThemeEnum)
  • dark - Dark
  • light - Light
Enum"dark""light"
user_message_colorstring<= 7 characters
mentor_bubble_colorstring<= 7 characters
align_mentor_bubblestring(AlignMentorBubbleEnum)
  • left - Left
  • right - Right
Enum"left""right"
mentorstringread-onlyrequired
mentor_slugstringread-onlyrequired
mentor_unique_idstringread-onlyrequired
mentor_idintegerread-onlyrequired
metadataanyread-onlyrequired
mentor_visibility(MentorVisibilityEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
One of:
  • viewable_by_tenant_admins - Viewable By Tenant Admins
  • viewable_by_tenant_students - Viewable By Tenant Students
  • viewable_by_anyone - Viewable By Anyone
string or null(MentorVisibilityEnum)
Enum"viewable_by_tenant_admins""viewable_by_tenant_students""viewable_by_anyone"
enable_image_generationboolean or null
enable_web_browsingboolean or null
enable_code_interpreterboolean or null
enable_memory_componentbooleanread-onlyrequired
custom_cssstring or null
allow_anonymousbooleanread-onlyrequired
mentor_descriptionstringread-onlyrequired
suggested_promptsanyread-onlyrequired
proactive_responsestringread-onlyrequired
greeting_methodstringread-onlyrequired
mentor_toolsanyread-onlyrequired
can_use_toolsbooleanread-onlyrequired
llm_namestringread-onlyrequired
proactive_promptstringread-onlyrequired
disclaimerstringread-onlyrequired
enable_disclaimerbooleanread-onlyrequired
embed_is_context_awarebooleanread-onlyrequired
embed_open_by_defaultbooleanread-onlyrequired
embed_show_attachmentbooleanread-onlyrequired
embed_show_voice_callbooleanread-onlyrequired
embed_show_voice_recordbooleanread-onlyrequired
placeholder_promptstringread-onlyrequired
enable_email_chatbooleanread-onlyrequired
enable_spaced_repetitionbooleanread-onlyrequired
enable_instruction_modebooleanread-onlyrequired
enable_socratic_modebooleanread-onlyrequired
is_guided_mentorbooleanread-onlyrequired
enable_guided_promptsbooleanread-onlyrequired
enable_moderationbooleanread-onlyrequired
enable_multi_query_ragbooleanread-onlyrequired
enable_post_processing_systembooleanread-onlyrequired
enable_safety_systembooleanread-onlyrequired
forkablebooleanread-onlyrequired
forkable_with_training_databooleanread-onlyrequired
mentor_namestringread-onlyrequired
categoriesArray of objects(MentorCategory)read-onlyrequired
categories[].​idintegerread-onlyrequired
categories[].​namestring<= 255 charactersrequired
categories[].​descriptionstring or null<= 255 characters
categories[].​category_groupinteger or null
categories[].​audienceobject(MentorAudience)required
categories[].​audience.​idintegerread-onlyrequired
categories[].​audience.​namestring<= 255 charactersrequired
categories[].​audience.​descriptionstring or null<= 255 characters
categories[].​audiencesArray of objects(MentorAudience)required
categories[].​audiences[].​idintegerread-onlyrequired
categories[].​audiences[].​namestring<= 255 charactersrequired
categories[].​audiences[].​descriptionstring or null<= 255 characters
typesArray of objects(MentorType)read-onlyrequired
types[].​idintegerread-onlyrequired
types[].​namestring<= 255 charactersrequired
types[].​descriptionstring or null
subjectsArray of objects(Subject)read-onlyrequired
subjects[].​idintegerread-onlyrequired
subjects[].​namestring<= 255 charactersrequired
subjects[].​descriptionstring or null
recently_accessed_atstring(date-time)read-onlyrequired
created_bystringread-onlyrequired
created_atstring(date-time)read-onlyrequired
updated_atstring(date-time)read-onlyrequired
platform_keystringread-onlyrequired
llm_configanyread-onlyrequired
Response
application/json
{
  "mentor": "mentor_123",
  "display_name": "John Doe",
  "profile_image": "https://example.com/image.jpg",
  "theme": "dark",
  "enable_image_generation": true
}

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