Skip to content
API Reference
/
ai-mentor
/
ai_mentor_orgs_trigger_deletion_create

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_trigger_retrieve

Request

Retrieve details of a specific trigger.

Args: request: The HTTP request. org: The organization/tenant identifier. slug: The unique slug identifier of the trigger.

Returns: Response: The details of the specified trigger.

Raises: Http404: If the specified trigger does not exist.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
slugstringrequired
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/trigger/{slug}/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
slugstringrequired
templatestring or nullread-onlyrequired
platformstring or nullread-onlyrequired
parametersany or nullread-onlyrequired
Response
application/json
{
  "slug": "trggr-slug-1",
  "template": "url_to_email_everyday",
  "platform": "main",
  "parameters": {
    "recipients": [ … ],
    "trigger_url": "https://google.com"
  }
}

ai_mentor_orgs_trigger_deletion_create

Request

Delete a specific trigger.

Args: request: The HTTP request. org: The organization/tenant identifier. slug: The unique slug identifier of the trigger to delete.

Returns: Response: A confirmation of the deletion status.

Raises: BadRequest: If the specified trigger does not exist.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
slugstringrequired
curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/trigger/{slug}/deletion/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Trigger successfully deleted

ai_mentor_orgs_users_list

Request

Retrieve a list of mentors.

Returns:

  • List of mentors matching the filters.
Security
PlatformApiKeyAuthentication
Path
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

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

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 GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/?department_id=0&filter_by=string&metadata_key=string&metadata_value=string&page=0&page_size=0&return_session_information=true&visibility=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(Mentor)required
results[].​namestring<= 255 charactersrequired
results[].​unique_idstring(uuid)
results[].​flowanyrequired

The langflow json for the mentor

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

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

results[].​enable_total_groundingboolean

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

results[].​enable_suggested_promptsboolean

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

results[].​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.

results[].​guided_prompt_instructionsstring

Instructions to determine how prompt suggestions are generated.

results[].​google_voiceinteger or null
results[].​openai_voiceinteger or null
results[].​categoriesArray of objects(MentorCategory)required
results[].​categories[].​idintegerread-onlyrequired
results[].​categories[].​namestring<= 255 charactersrequired
results[].​categories[].​descriptionstring or null<= 255 characters
results[].​categories[].​category_groupinteger or null
results[].​categories[].​audienceobject(MentorAudience)required
results[].​categories[].​audience.​idintegerread-onlyrequired
results[].​categories[].​audience.​namestring<= 255 charactersrequired
results[].​categories[].​audience.​descriptionstring or null<= 255 characters
results[].​categories[].​audiencesArray of objects(MentorAudience)required
results[].​categories[].​audiences[].​idintegerread-onlyrequired
results[].​categories[].​audiences[].​namestring<= 255 charactersrequired
results[].​categories[].​audiences[].​descriptionstring or null<= 255 characters
results[].​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

results[].​moderation_system_promptstring

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

results[].​post_processing_promptstring

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

results[].​moderation_responsestring

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

results[].​safety_system_promptstring

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

results[].​safety_responsestring

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

results[].​enable_safety_systemboolean
results[].​proactive_responsestring

Response to start a conversation with a user.

results[].​greeting_methodstring
  • proactive_prompt - Proactive Prompt
  • proactive_response - Proactive Response
Enum"proactive_prompt""proactive_response"
results[].​call_configurationobject(CallConfiguration)
results[].​mcp_serversArray of objects(MCPServer)required
results[].​mcp_servers[].​idintegerread-onlyrequired
results[].​mcp_servers[].​platformintegerread-onlyrequired
results[].​mcp_servers[].​namestring<= 255 charactersrequired
results[].​mcp_servers[].​urlstring(uri)<= 200 charactersrequired

The url of the MCP server.

results[].​mcp_servers[].​transportstring(TransportEnum)
  • sse - Sse
  • websocket - Websocket
Enum"sse""websocket"
results[].​mcp_servers[].​headersany

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

results[].​mcp_servers[].​platform_keystringread-onlyrequired
results[].​mcp_servers[].​created_atstring(date-time)read-onlyrequired
results[].​mcp_servers[].​updated_atstring(date-time)read-onlyrequired
results[].​last_accessed_byinteger or null[ 0 .. 2147483647 ]

edX user ID

results[].​recently_accessed_atstring or null(date-time)
results[].​created_bystring or null<= 255 characters
results[].​created_atstring or null(date-time)read-onlyrequired
results[].​updated_atstring or null(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