Skip to content
API Reference
/
ai-mentor

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_all_triggers_retrieve

Request

List all triggers for an organization.

Args: request: The HTTP request. org: The organization/tenant identifier.

Returns: Response: A list of trigger slugs for the organization.

Raises: BadRequest: If the request is invalid.

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

Responses

List of trigger slugs

ai_mentor_orgs_mentors_email_inbox_list

Request

Retrieve a list of emails in a mentor's inbox.

The list can be filtered using the 'search' query parameter to search for specific terms in the email content or subject.

Args: mentor: The unique identifier of the mentor.

Returns: Response: A paginated list of emails in the mentor's inbox.

Raises: NotFound: If the specified mentor does not exist.

Security
PlatformApiKeyAuthentication
Path
mentorstringrequired
orgstringrequired
Query
pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

searchstring

Search term to filter emails by content or subject

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/mentors/{mentor}/email-inbox/?page=0&page_size=0&search=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(EmailPromptList)required
results[].​idintegerread-onlyrequired
results[].​sender_emailstring(email)<= 254 charactersrequired
results[].​sender_namestring or null
results[].​subjectstring or null
results[].​content_summarystring or nullread-onlyrequired
results[].​mentor_namestring or null
results[].​mentor_emailstring(email)<= 254 charactersrequired
results[].​is_processedboolean
results[].​inserted_atstringread-onlyrequired
Response
application/json
{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    [ … ]
  ]
}

ai_mentor_orgs_mentors_email_inbox_summary_retrieve

Request

Retrieve a summary of a mentor's email inbox.

Args: request: The HTTP request. mentor: The unique identifier of the mentor.

Returns: Response: A summary of the mentor's email inbox statistics.

Raises: NotFound: If the specified mentor does not exist.

Security
PlatformApiKeyAuthentication
Path
mentorstringrequired
orgstringrequired
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/mentors/{mentor}/email-inbox-summary/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
total_emailsintegerread-onlyrequired
replied_emailsintegerread-onlyrequired
pending_emailsintegerread-onlyrequired
Response
application/json
{
  "total_emails": 25,
  "replied_emails": 18,
  "pending_emails": 7
}

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