Skip to content
API Reference/
/
List projects

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_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
Body
required
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": [ … ]
  }
}

List projects

Request

Retrieve a list of projects with optional filtering and search.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Query
limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

orderingstring

Which field to use when ordering the results.

searchstring

Search in project name and description

sharedboolean

Filter by shared status (true/false)

sortstring

Order by field (prefix with - for descending). Example: name or -created_at

Examples:
sort=name
sort=-name
sort=created_at
sort=-created_at
usernamestring

Filter projects by owner's username

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/projects/?limit=0&offset=0&ordering=string&search=string&shared=true&sort=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/?offset=400&limit=100"
previousstring or null(uri)
Example: "http://api.example.org/accounts/?offset=200&limit=100"
resultsArray of objects(Project)required
results[].​idintegerread-onlyrequired
results[].​namestring<= 255 charactersrequired

Name of the project

results[].​descriptionstring

Description of the project

results[].​sharedboolean

Whether this project is shared with others or personal

results[].​ownerinteger[ 0 .. 2147483647 ]read-onlyrequired

User who created this project

results[].​owner_usernamestringread-onlyrequired
results[].​platforminteger or nullread-onlyrequired

Platform this project belongs to

results[].​platform_keystringread-onlyrequired
results[].​platform_namestringread-onlyrequired
results[].​mentor_countintegerread-onlyrequired
results[].​is_personalbooleanread-onlyrequired
results[].​created_atstring(date-time)read-onlyrequired
results[].​updated_atstring(date-time)read-onlyrequired
results[].​mentorsArray of objects(ProjectMentor)read-onlyrequired
results[].​mentors[].​idintegerread-onlyrequired
results[].​mentors[].​namestring<= 255 charactersrequired
results[].​mentors[].​descriptionstring or null
results[].​mentors[].​unique_idstring(uuid)read-onlyrequired
results[].​mentors[].​slugstring^[-a-zA-Z0-9_]+$read-onlyrequired
results[].​mentors[].​created_atstring or null(date-time)read-onlyrequired
Response
application/json
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    [ … ]
  ]
}

Create a new project

Request

Create a new project with optional mentors.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Body
required
namestring<= 255 charactersrequired

Name of the project

descriptionstring

Description of the project

sharedboolean

Whether this project is shared with others or personal

mentors_to_addArray of strings(uuid)write-only

List of mentor unique IDs to add to the project

mentors_to_removeArray of strings(uuid)write-only

List of mentor unique IDs to remove from the project

curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/projects/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Machine Learning Basics",
    "description": "A project for learning machine learning fundamentals",
    "shared": true,
    "mentors_to_add": [
      "550e8400-e29b-41d4-a716-446655440000",
      "550e8400-e29b-41d4-a716-446655440001"
    ]
  }'

Responses

Bodyapplication/json
idintegerread-onlyrequired
namestring<= 255 charactersrequired

Name of the project

descriptionstring

Description of the project

sharedboolean

Whether this project is shared with others or personal

ownerinteger[ 0 .. 2147483647 ]read-onlyrequired

User who created this project

owner_usernamestringread-onlyrequired
platforminteger or nullread-onlyrequired

Platform this project belongs to

platform_keystringread-onlyrequired
platform_namestringread-onlyrequired
mentor_countintegerread-onlyrequired
is_personalbooleanread-onlyrequired
created_atstring(date-time)read-onlyrequired
updated_atstring(date-time)read-onlyrequired
mentorsArray of objects(ProjectMentor)read-onlyrequired
mentors[].​idintegerread-onlyrequired
mentors[].​namestring<= 255 charactersrequired
mentors[].​descriptionstring or null
mentors[].​unique_idstring(uuid)read-onlyrequired
mentors[].​slugstring^[-a-zA-Z0-9_]+$read-onlyrequired
mentors[].​created_atstring or null(date-time)read-onlyrequired
Response
application/json
{
  "id": 1,
  "name": "Machine Learning Basics",
  "description": "A project for learning machine learning fundamentals",
  "shared": true,
  "owner": 1,
  "owner_username": "john_doe",
  "platform": 1,
  "platform_key": "main",
  "platform_name": "main",
  "mentor_count": 2,
  "is_personal": false,
  "mentors": [
    { … }
  ],
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

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