features_bulk_config

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-prompt

Operations

career

Operations

catalog

Operations

core

Operations

credentials

Operations

features

Operations

features_apps_list

Request

Returns a list of the apps that the user has access to.

Security

PlatformApiKeyAuthentication

Query

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/features/apps/?page=0&page_size=0' \
  -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(UserApp)required

results[].idintegerread-onlyrequired

results[].appobjectrequired

The app details

results[].app.namestring<= 255 charactersrequired

results[].app.urlstring<= 255 charactersrequired

results[].app.typestring<= 50 charactersrequired

results[].app.metadataany

results[].app.onboarding_requiredboolean

If true, users will be required to complete onboarding before using this app

results[].platformobjectread-onlyrequired

Note: Create and update operations deprecated.

results[].platform.keystring<= 200 charactersrequired

The platform key

results[].platform.namestring or null<= 200 characters

The name of the platform

results[].platform.orgstring or null<= 200 characters

The associated edX org code

results[].platform.lms_urlstring or null(uri)<= 300 characters

The LMS URL for the platform

results[].platform.cms_urlstring or null(uri)<= 300 characters

The CMS URL for the platform

results[].platform.portal_urlstring or null(uri)<= 300 characters

The portal URL for the platform

results[].subscriptionobject or nullread-onlyrequired

The subscription details, would contain identifier, active, created_on, last_updated

results[].subscription.property name*anyadditional property

results[].providerstringrequired

results[].is_adminbooleanread-onlyrequired

results[].is_activebooleanread-onlyrequired

results[].metadataany

results[].onboarding_completedboolean

results[].free_trial_startedboolean

results[].free_trial_expiredboolean

results[].has_active_subscriptionboolean

Response

application/json

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    { … }
  ]
}

features_apps_update_create

Request

Updates the user onboarding completed status

Security

PlatformApiKeyAuthentication

Body

required

onboarding_completedbooleanrequired

appstringrequired

The app url or name or id

curl -i -X POST \
  https://docs.ibl.ai/_mock/apis/ibl/api/features/apps/update/ \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "onboarding_completed": true,
    "app": "string"
  }'

Responses

Bodyapplication/json

onboarding_completedbooleanrequired

appstringrequired

The app url or name or id

Response

application/json

{
  "onboarding_completed": true,
  "app": "string"
}

features_apps_update_trial_status_create

Request

Activates free trial for the user

Set free_trial_started to True| false for the user app

App URL or ID is required as well as the platform key

Security

PlatformApiKeyAuthentication

Body

required

free_trial_startedboolean

Default true

appstringrequired

The app url or name or id

platformstringrequired

The platform key

curl -i -X POST \
  https://docs.ibl.ai/_mock/apis/ibl/api/features/apps/update-trial-status/ \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "free_trial_started": true,
    "app": "string",
    "platform": "string"
  }'

Responses

Bodyapplication/json

free_trial_startedboolean

Default true

appstringrequired

The app url or name or id

platformstringrequired

The platform key

Response

application/json

{
  "free_trial_started": true,
  "app": "string",
  "platform": "string"
}