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

Operations

career

Operations

catalog

Operations

core

Operations

core_orgs_thumbnail_create_create

Request

Upload a new platform logo

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
Bodyrequired
filestring(uri)required
curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/core/orgs/{org}/thumbnail/create/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "file": "http://example.com"
  }'

Responses

Bodyapplication/json
filestring(uri)required
Response
application/json
{ "file": "http://example.com" }

core_platform_retrieve

Request

GET /api/core/platform/ Get main platform info.

POST /api/core/platform/ Save main platform settings.

Params: user_id (optional) key field_key (POST) value (POST)

Security
PlatformApiKeyAuthentication
Query
keystringnon-emptyrequired
user_idinteger
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/core/platform/?key=string&user_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
keystring<= 200 charactersrequired

The platform key

namestring or null<= 200 characters

The name of the platform

orgstring or null<= 200 characters

The associated edX org code

lms_urlstring or null(uri)<= 300 characters

The LMS URL for the platform

cms_urlstring or null(uri)<= 300 characters

The CMS URL for the platform

portal_urlstring or null(uri)<= 300 characters

The portal URL for the platform

statusinteger[ -2147483648 .. 2147483647 ]
  • -2 - FAILED
  • -1 - TERMINATED
  • 0 - PENDING
  • 1 - BUILDING
  • 2 - RUNNING
  • 3 - PAUSED
  • 4 - STOPPING
  • 5 - STOPPED
  • 6 - REPAIR
Enum-2-10123456
activeboolean
Response
application/json
{ "key": "string", "name": "string", "org": "string", "lms_url": "http://example.com", "cms_url": "http://example.com", "portal_url": "http://example.com", "status": -2, "active": true }

core_platform_create

Request

Update platform object

Params: user_id

key new_key (If changing platform key) name

Advanced Params (Don't expose these to users) lms_url cms_url portal_url

Security
PlatformApiKeyAuthentication
Bodyrequired
user_idintegerrequired
keystringrequired
new_keystring
namestring
lms_urlstring
cms_urlstring
portal_urlstring
curl -i -X POST \
  https://docs.ibl.ai/_mock/apis/ibl/api/core/platform/ \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "user_id": 0,
    "key": "string",
    "new_key": "string",
    "name": "string",
    "lms_url": "string",
    "cms_url": "string",
    "portal_url": "string"
  }'

Responses

Bodyapplication/json
keystring<= 200 charactersrequired

The platform key

namestring or null<= 200 characters

The name of the platform

orgstring or null<= 200 characters

The associated edX org code

lms_urlstring or null(uri)<= 300 characters

The LMS URL for the platform

cms_urlstring or null(uri)<= 300 characters

The CMS URL for the platform

portal_urlstring or null(uri)<= 300 characters

The portal URL for the platform

statusinteger[ -2147483648 .. 2147483647 ]
  • -2 - FAILED
  • -1 - TERMINATED
  • 0 - PENDING
  • 1 - BUILDING
  • 2 - RUNNING
  • 3 - PAUSED
  • 4 - STOPPING
  • 5 - STOPPED
  • 6 - REPAIR
Enum-2-10123456
activeboolean
Response
application/json
{ "key": "string", "name": "string", "org": "string", "lms_url": "http://example.com", "cms_url": "http://example.com", "portal_url": "http://example.com", "status": -2, "active": true }

credentials

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

Operations