Skip to content
API Reference/
/
Retrieve Mentor Settings

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

Update Mentor Settings

Request

Update various mentor settings including system prompts, tool permissions, and UI configurations.

Security
PlatformApiKeyAuthentication
Path
mentorstringrequired
orgstringrequired
user_idstringrequired
Query
department_idinteger

Department to authorize users by

Body
mentor_namestring
template_namestring
display_namestring
profile_imagestring(uri)
initial_messagestring or null
suggested_messagestring or null
themestring
user_message_colorstring
mentor_bubble_colorstring
align_mentor_bubblestring
system_promptstring
llm_providerstring
llm_namestring
featuredboolean
disable_chathistoryboolean
metadataany or null
custom_cssstring or null
department_idinteger or null

Department to authorize users by

mentor_visibilitystring
enable_image_generationboolean
enable_web_browsingboolean
enable_code_interpreterboolean
allow_anonymousboolean
forkableboolean
forkable_with_training_databoolean
mentor_descriptionstring
uploaded_profile_imagestring(uri)
proactive_responsestring
greeting_methodstring(GreetingMethodEnum)
  • proactive_prompt - Proactive Prompt
  • proactive_response - Proactive Response
Enum"proactive_prompt""proactive_response"
can_use_toolsboolean
tool_slugsArray of strings
llm_temperaturenumber(double)[ 0 .. 1 ]
proactive_promptstring
disclaimerstring
placeholder_promptstring
moderation_system_promptstring
post_processing_promptstring
moderation_responsestring
enable_moderationboolean
enable_multi_query_ragboolean
enable_post_processing_systemboolean
enable_openai_assistantboolean
enable_total_groundingboolean
enable_suggested_promptsboolean or null
enable_guided_promptsboolean or null
mcp_serversArray of integers or null
embed_is_context_awareboolean
embed_open_by_defaultboolean
embed_show_attachmentboolean
embed_show_voice_callboolean
embed_show_voice_recordboolean
google_voiceinteger
openai_voiceinteger
guided_prompt_instructionsstring or null
safety_system_promptstring
safety_responsestring
enable_safety_systemboolean
enable_spaced_repetitionboolean
Default false
enable_instruction_modeboolean
Default false
enable_socratic_modeboolean
Default false
is_guided_mentorboolean
Default false
enable_email_chatboolean
Default false
categoriesArray of integers
typesArray of integers
subjectsArray of integers
curl -i -X PUT \
  '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' \
  -H 'Content-Type: multipart/form-data' \
  -F mentor_name=string \
  -F template_name=string \
  -F display_name=string \
  -F profile_image=http://example.com \
  -F initial_message=string \
  -F suggested_message=string \
  -F theme=string \
  -F user_message_color=string \
  -F mentor_bubble_color=string \
  -F align_mentor_bubble=string \
  -F system_prompt=string \
  -F llm_provider=string \
  -F llm_name=string \
  -F featured=true \
  -F disable_chathistory=true \
  -F metadata=null \
  -F custom_css=string \
  -F department_id=0 \
  -F mentor_visibility=string \
  -F enable_image_generation=true \
  -F enable_web_browsing=true \
  -F enable_code_interpreter=true \
  -F allow_anonymous=true \
  -F forkable=true \
  -F forkable_with_training_data=true \
  -F mentor_description=string \
  -F uploaded_profile_image=http://example.com \
  -F proactive_response=string \
  -F greeting_method=proactive_prompt \
  -F can_use_tools=true \
  -F tool_slugs=string \
  -F llm_temperature=1 \
  -F proactive_prompt=string \
  -F disclaimer=string \
  -F placeholder_prompt=string \
  -F moderation_system_prompt=string \
  -F post_processing_prompt=string \
  -F moderation_response=string \
  -F enable_moderation=true \
  -F enable_multi_query_rag=true \
  -F enable_post_processing_system=true \
  -F enable_openai_assistant=true \
  -F enable_total_grounding=true \
  -F enable_suggested_prompts=true \
  -F enable_guided_prompts=true \
  -F 'mcp_servers[0]=0' \
  -F embed_is_context_aware=true \
  -F embed_open_by_default=true \
  -F embed_show_attachment=true \
  -F embed_show_voice_call=true \
  -F embed_show_voice_record=true \
  -F google_voice=0 \
  -F openai_voice=0 \
  -F guided_prompt_instructions=string \
  -F safety_system_prompt=string \
  -F safety_response=string \
  -F enable_safety_system=true \
  -F enable_spaced_repetition=false \
  -F enable_instruction_mode=false \
  -F enable_socratic_mode=false \
  -F is_guided_mentor=false \
  -F enable_email_chat=false \
  -F 'categories[0]=0' \
  -F 'types[0]=0' \
  -F 'subjects[0]=0'

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
system_promptstringread-onlyrequired
llm_providerstringread-onlyrequired
llm_temperaturenumber(double)read-onlyrequired
safety_system_promptstringread-onlyrequired
safety_responsestringread-onlyrequired
moderation_system_promptstringread-onlyrequired
post_processing_promptstringread-onlyrequired
moderation_responsestringread-onlyrequired
mcp_serversArray of objects(MCPServer)read-onlyrequired
mcp_servers[].​idintegerread-onlyrequired
mcp_servers[].​platformintegerread-onlyrequired
mcp_servers[].​namestring<= 255 charactersrequired
mcp_servers[].​urlstring(uri)<= 200 charactersrequired

The url of the MCP server.

mcp_servers[].​imagestring or null(uri)
mcp_servers[].​transportstring(TransportEnum)
  • sse - Sse
  • websocket - Websocket
  • streamable_http - Streamable Http
Enum"sse""websocket""streamable_http"
mcp_servers[].​extra_headersany

Headers to send to the MCP server. Useful for authentication,

mcp_servers[].​platform_keystringread-onlyrequired
mcp_servers[].​is_featuredboolean

Featured mcp servers will be accessible to all other tenants.

mcp_servers[].​created_atstring(date-time)read-onlyrequired
mcp_servers[].​updated_atstring(date-time)read-onlyrequired
departmentstringread-onlyrequired
disable_chathistorystringread-onlyrequired
call_configurationobjectread-onlyrequired
call_configuration.​idintegerread-onlyrequired
call_configuration.​mentorstring(uuid)required
call_configuration.​modestring(CallConfigurationModeEnum)
  • realtime - Realtime
  • inference - Inference
Enum"realtime""inference"
call_configuration.​tts_providerstring(TtsProviderEnum)
  • openai - Openai
  • google - Google
  • elevenlabs - Elevenlabs
Enum"openai""google""elevenlabs"
call_configuration.​stt_providerstring(SttProviderEnum)
  • openai - Openai
  • google - Google
  • deepgram - Deepgram
  • cartesia - Cartesia
Enum"openai""google""deepgram""cartesia"
call_configuration.​llm_providerstring(LlmProviderEnum)
  • openai - Openai
  • google - Google
Enum"openai""google"
call_configuration.​use_function_calling_for_ragboolean

Whether to use function calls in the agent or force RAG calls before LLM generation

call_configuration.​google_voiceobject(Voice)
call_configuration.​openai_voiceobject(Voice)
call_configuration.​openai_voice_idinteger or null
call_configuration.​google_voice_idinteger or null
call_configuration.​enable_videoboolean

Whether to enable video for the call. (applicable only for realtime mode)

call_configuration.​platform_keystringread-onlyrequired
guided_prompt_instructionsstringread-onlyrequired
seo_tagsanyread-onlyrequired
marketing_conversationsanyread-onlyrequired
template_mentoranyread-onlyrequired
google_voicestringread-onlyrequired
openai_voicestringread-onlyrequired
enable_openai_assistantbooleanread-onlyrequired
enable_total_groundingbooleanread-onlyrequired
enable_suggested_promptsbooleanread-onlyrequired
is_deletedbooleanread-onlyrequired
Response
application/json
{
  "id": 0,
  "display_name": "string",
  "profile_image": "string",
  "initial_message": "string",
  "suggested_message": "string",
  "theme": "dark",
  "user_message_color": "string",
  "mentor_bubble_color": "string",
  "align_mentor_bubble": "left",
  "mentor": "string",
  "mentor_slug": "string",
  "mentor_unique_id": "string",
  "mentor_id": 0,
  "metadata": null,
  "mentor_visibility": "viewable_by_tenant_admins",
  "enable_image_generation": true,
  "enable_web_browsing": true,
  "enable_code_interpreter": true,
  "enable_memory_component": true,
  "custom_css": "string",
  "allow_anonymous": true,
  "mentor_description": "string",
  "suggested_prompts": null,
  "proactive_response": "string",
  "greeting_method": "string",
  "mentor_tools": null,
  "can_use_tools": true,
  "llm_name": "string",
  "proactive_prompt": "string",
  "disclaimer": "string",
  "enable_disclaimer": true,
  "embed_is_context_aware": true,
  "embed_open_by_default": true,
  "embed_show_attachment": true,
  "embed_show_voice_call": true,
  "embed_show_voice_record": true,
  "placeholder_prompt": "string",
  "enable_email_chat": true,
  "enable_spaced_repetition": true,
  "enable_instruction_mode": true,
  "enable_socratic_mode": true,
  "is_guided_mentor": true,
  "enable_guided_prompts": true,
  "enable_moderation": true,
  "enable_multi_query_rag": true,
  "enable_post_processing_system": true,
  "enable_safety_system": true,
  "forkable": true,
  "forkable_with_training_data": true,
  "mentor_name": "string",
  "categories": [
    { … }
  ],
  "types": [
    { … }
  ],
  "subjects": [
    { … }
  ],
  "recently_accessed_at": "2019-08-24T14:15:22Z",
  "created_by": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "platform_key": "string",
  "llm_config": null,
  "system_prompt": "string",
  "llm_provider": "string",
  "llm_temperature": 0.1,
  "safety_system_prompt": "string",
  "safety_response": "string",
  "moderation_system_prompt": "string",
  "post_processing_prompt": "string",
  "moderation_response": "string",
  "mcp_servers": [
    { … }
  ],
  "department": "string",
  "disable_chathistory": "string",
  "call_configuration": {
    "id": 0,
    "mentor": "ecbf8dc6-e97d-4602-939f-cda86082faa0",
    "mode": "realtime",
    "tts_provider": "openai",
    "stt_provider": "openai",
    "llm_provider": "openai",
    "use_function_calling_for_rag": true,
    "google_voice": { … },
    "openai_voice": { … },
    "openai_voice_id": 0,
    "google_voice_id": 0,
    "enable_video": true,
    "platform_key": "string"
  },
  "guided_prompt_instructions": "string",
  "seo_tags": null,
  "marketing_conversations": null,
  "template_mentor": null,
  "google_voice": "string",
  "openai_voice": "string",
  "enable_openai_assistant": true,
  "enable_total_grounding": true,
  "enable_suggested_prompts": true,
  "is_deleted": 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