Skip to content

ibl-data-manager (3.59.0-ai-plus)

API for iblai

Download OpenAPI description
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_playwright_scripts_destroy

Request

Endpoints for viewing playwright scripts and updating playwright scripts for a tenant and user.

Security
PlatformApiKeyAuthentication
Path
idintegerrequired

A unique integer value identifying this play wright script.

orgstringrequired
user_idstringrequired
curl -i -X DELETE \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/playwright-scripts/{id}/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

No response body

ai_mentor_orgs_users_predictive_analytics_create

Request

Retrieve predictive analytics based on historical data variables.

Args: request: HTTP request containing predictive analytics input. org: Organization key identifier.

Returns:

  • 200: Object containing predicted data.
  • 400: When AI response cannot be loaded into JSON.
  • 404: When OpenAI key for the tenant is not set.
  • 429: When OpenAI request exceeds the rate limit.

Example: POST /api/ai-prompt/orgs/main/users/johndoe/predictive-analytics/

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Bodyrequired
promptobject(ReuestDataVariableList)required
prompt.​data_variablesArray of objects(RequestDataVariable)required
prompt.​data_variables[].​variable_namestringrequired

Variable Name

prompt.​data_variables[].​data_setanyrequired

Data set to be used for prediction

prompt.​data_variables[].​number_of_data_pointsintegerrequired

Number of Data Points

curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/predictive-analytics/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "prompt": {
      "data_variables": [
        {
          "variable_name": "registered_users",
          "data_set": {
            "2023-10-06": 4,
            "2023-10-07": 1,
            "2023-10-08": 0,
            "2023-10-09": 5,
            "2023-10-10": 4
          },
          "number_of_data_points": 5
        },
        {
          "variable_name": "courses_enrolled",
          "data_set": {
            "2023-08-09": 0,
            "2023-08-10": 0,
            "2023-08-11": 0,
            "2023-08-12": 0,
            "2023-08-13": 0
          },
          "number_of_data_points": 6
        }
      ]
    }
  }'

Responses

Bodyapplication/json
predictionsArray of objects(ResponseDataVariable)required
predictions[].​variable_namestringrequired

Variable Name

predictions[].​predicted_dataanyrequired

Predicted data

predictions[].​narrativestringrequired

Explanation of prediction

Response
application/json
{ "prompt": { "data_variables": [] } }

ai_mentor_orgs_users_recent_messages_retrieve

Request

Retrieves recent chat messages based on provided query parameters.

Returns: 200: Paginated List of chat messages. 400: Invalid query parameters.

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

Responses

No response body

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