Skip to content
API Reference
/
ai-mentor
/
ai_mentor_orgs_users_destroy

ibl-data-manager (3.59.0-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_partial_update

Request

API ViewSet for managing mentors.

Provides endpoints to retrieve, create, update, and delete mentor data.

Permissions: - Accessible to both tenant admins and students.

Security
PlatformApiKeyAuthentication
Path
namestringrequired
orgstringrequired
user_idstringrequired
Query
department_idinteger

Department to filter by

filter_bystringnon-empty

Filter options include, date, name, default is date

metadata_keystringnon-empty

Metadata key to be queried with

metadata_valuestringnon-empty

Metadata value to be filter for

return_session_informationboolean

Declares if session information should be included in the mentor data

visibilitystringnon-empty

visibility type to be queried with

Body
namestring<= 255 characters
unique_idstring(uuid)
flowany

The langflow json for the mentor

slugstring<= 255 characters^[-a-zA-Z0-9_]+$
platformstring<= 255 characters
allow_anonymousboolean
metadataany or null
enable_moderationboolean
enable_post_processing_systemboolean
enable_openai_assistantboolean

(Deprecated) Set template mentor to openai-agent instead.

enable_total_groundingboolean

Whether to force mentor to only use information within the provided documents.

enable_suggested_promptsboolean

Whether to show suggested prompts for the mentor or not. Note: Suggested prompts are created by tenant admins.

enable_guided_promptsboolean

Whether to show suggested prompts for the mentor or not. Note: Guided prompts are created with an llm based on chat history.

google_voiceinteger or null
openai_voiceinteger or null
guided_prompt_instructionsstring

Instructions to determine how prompt suggestions are generated.

categoriesArray of integers
proactive_promptstring

Prompt template used to start a conversation with the user when greeting_type is proactive_prompt. This will be sent to the LLM so it can respond naturally

moderation_system_promptstring

The prompt for the moderation system. This prompt must clearly distinguish between 'Approapriate' and 'Not Appropriate' queries.

post_processing_promptstring

Prompt to be used to alter or modify final llm response into any desired form.

moderation_responsestring

Desired feedback to return to the user when their prompt is deemed inappropriate.

safety_system_promptstring

Prompt to check whether the models response is appropriate or not.

safety_responsestring

Feedback given to the user when a model generates an inappropriate response

disable_chathistoryboolean
enable_safety_systemboolean
proactive_responsestring

Response to start a conversation with a user.

mcp_serversArray of integers
greeting_methodstring
  • proactive_prompt - Proactive Prompt
  • proactive_response - Proactive Response
Enum"proactive_prompt""proactive_response"
last_accessed_byinteger or null[ 0 .. 2147483647 ]

edX user ID

recently_accessed_atstring or null(date-time)
created_bystring or null<= 255 characters
curl -i -X PATCH \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/{name}/?department_id=0&filter_by=string&metadata_key=string&metadata_value=string&return_session_information=true&visibility=string' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "unique_id": "677cf8c4-9b37-4a4b-b000-2ee947357c3a",
    "flow": null,
    "slug": "string",
    "platform": "string",
    "allow_anonymous": true,
    "metadata": null,
    "enable_moderation": true,
    "enable_post_processing_system": true,
    "enable_openai_assistant": true,
    "enable_total_grounding": true,
    "enable_suggested_prompts": true,
    "enable_guided_prompts": true,
    "google_voice": 0,
    "openai_voice": 0,
    "guided_prompt_instructions": "string",
    "categories": [
      0
    ],
    "proactive_prompt": "string",
    "moderation_system_prompt": "string",
    "post_processing_prompt": "string",
    "moderation_response": "string",
    "safety_system_prompt": "string",
    "safety_response": "string",
    "disable_chathistory": true,
    "enable_safety_system": true,
    "proactive_response": "string",
    "mcp_servers": [
      0
    ],
    "greeting_method": "proactive_prompt",
    "last_accessed_by": 2147483647,
    "recently_accessed_at": "2019-08-24T14:15:22Z",
    "created_by": "string"
  }'

Responses

Bodyapplication/json
namestring<= 255 charactersrequired
unique_idstring(uuid)
flowanyrequired

The langflow json for the mentor

slugstring<= 255 characters^[-a-zA-Z0-9_]+$
platformstring<= 255 characters
allow_anonymousboolean
metadataany or null
enable_moderationboolean
enable_post_processing_systemboolean
enable_openai_assistantboolean

(Deprecated) Set template mentor to openai-agent instead.

enable_total_groundingboolean

Whether to force mentor to only use information within the provided documents.

enable_suggested_promptsboolean

Whether to show suggested prompts for the mentor or not. Note: Suggested prompts are created by tenant admins.

enable_guided_promptsboolean

Whether to show suggested prompts for the mentor or not. Note: Guided prompts are created with an llm based on chat history.

google_voiceinteger or null
openai_voiceinteger or null
guided_prompt_instructionsstring

Instructions to determine how prompt suggestions are generated.

categoriesArray of integers
proactive_promptstring

Prompt template used to start a conversation with the user when greeting_type is proactive_prompt. This will be sent to the LLM so it can respond naturally

moderation_system_promptstring

The prompt for the moderation system. This prompt must clearly distinguish between 'Approapriate' and 'Not Appropriate' queries.

post_processing_promptstring

Prompt to be used to alter or modify final llm response into any desired form.

moderation_responsestring

Desired feedback to return to the user when their prompt is deemed inappropriate.

safety_system_promptstring

Prompt to check whether the models response is appropriate or not.

safety_responsestring

Feedback given to the user when a model generates an inappropriate response

disable_chathistoryboolean
enable_safety_systemboolean
proactive_responsestring

Response to start a conversation with a user.

mcp_serversArray of integers
greeting_methodstring
  • proactive_prompt - Proactive Prompt
  • proactive_response - Proactive Response
Enum"proactive_prompt""proactive_response"
last_accessed_byinteger or null[ 0 .. 2147483647 ]

edX user ID

recently_accessed_atstring or null(date-time)
created_bystring or null<= 255 characters
created_atstring or null(date-time)read-onlyrequired
updated_atstring or null(date-time)read-onlyrequired
Response
application/json
{
  "name": "string",
  "unique_id": "677cf8c4-9b37-4a4b-b000-2ee947357c3a",
  "flow": null,
  "slug": "string",
  "platform": "string",
  "allow_anonymous": true,
  "metadata": null,
  "enable_moderation": true,
  "enable_post_processing_system": true,
  "enable_openai_assistant": true,
  "enable_total_grounding": true,
  "enable_suggested_prompts": true,
  "enable_guided_prompts": true,
  "google_voice": 0,
  "openai_voice": 0,
  "guided_prompt_instructions": "string",
  "categories": [
    0
  ],
  "proactive_prompt": "string",
  "moderation_system_prompt": "string",
  "post_processing_prompt": "string",
  "moderation_response": "string",
  "safety_system_prompt": "string",
  "safety_response": "string",
  "disable_chathistory": true,
  "enable_safety_system": true,
  "proactive_response": "string",
  "mcp_servers": [
    0
  ],
  "greeting_method": "proactive_prompt",
  "last_accessed_by": 2147483647,
  "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"
}

ai_mentor_orgs_users_destroy

Request

Soft delete a mentor.

Security
PlatformApiKeyAuthentication
Path
namestringrequired
orgstringrequired
user_idstringrequired
Query
department_idinteger

Department to filter by

filter_bystringnon-empty

Filter options include, date, name, default is date

metadata_keystringnon-empty

Metadata key to be queried with

metadata_valuestringnon-empty

Metadata value to be filter for

return_session_informationboolean

Declares if session information should be included in the mentor data

visibilitystringnon-empty

visibility type to be queried with

curl -i -X DELETE \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/{name}/?department_id=0&filter_by=string&metadata_key=string&metadata_value=string&return_session_information=true&visibility=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

No response body

ai_mentor_orgs_users_ai_generated_images_list

Request

Endpoint to view and delete AI generated images for a user.

AI Generated images are images generated during chat with AI. They are cached to allow retrieval and deletion.

optional filtering parameters allowed are

  • username: The username of the user for which this image was stored.
  • provider: The provider used to generate the image. eg. openai, nvidia (nim), replicate.
  • model: the text to image model on the provider used to generate the image.

This endpoint is accessible to both students and platform admins.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Query
modelstring
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.

providerstring
searchstring

A search term.

usernamestring
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/ai-generated-images/?model=string&ordering=string&page=0&page_size=0&provider=string&search=string&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(AIGeneratedImage)required
results[].​idintegerread-onlyrequired
results[].​userinteger[ 0 .. 2147483647 ]required

edX user ID

results[].​imagestring(uri)required
results[].​platformintegerrequired
results[].​promptstring
results[].​modelstring<= 255 characters
results[].​providerstring<= 255 characters
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
Copyright © ibl.ai | support@iblai.zendesk.com