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_list

Request

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

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Query
is_publicboolean
orderingstring

Which field to use when ordering the results.

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

searchstring

A search term.

studentinteger[ 0 .. 2147483647 ]

edX user ID

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/playwright-scripts/?is_public=true&ordering=string&page=0&page_size=0&search=string&student=2147483647' \
  -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(PlayWrightScript)required
results[].​idintegerread-onlyrequired
results[].​platforminteger or nullread-onlyrequired
results[].​studentinteger or null[ 0 .. 2147483647 ]read-onlyrequired

edX user ID

results[].​titlestring<= 400 charactersrequired
results[].​descriptionstring<= 400 characters
results[].​scriptstringrequired
results[].​is_publicbooleanread-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_users_playwright_scripts_create

Request

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

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Bodyrequired
titlestring<= 400 charactersrequired
descriptionstring<= 400 characters
scriptstringrequired
curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/playwright-scripts/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "string",
    "description": "string",
    "script": "string"
  }'

Responses

Bodyapplication/json
idintegerread-onlyrequired
platforminteger or nullread-onlyrequired
studentinteger or null[ 0 .. 2147483647 ]read-onlyrequired

edX user ID

titlestring<= 400 charactersrequired
descriptionstring<= 400 characters
scriptstringrequired
is_publicbooleanread-onlyrequired
Response
application/json
{ "id": 0, "platform": 0, "student": 2147483647, "title": "string", "description": "string", "script": "string", "is_public": true }

ai_mentor_orgs_users_playwright_scripts_retrieve

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 GET \
  '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

Bodyapplication/json
idintegerread-onlyrequired
platforminteger or nullread-onlyrequired
studentinteger or null[ 0 .. 2147483647 ]read-onlyrequired

edX user ID

titlestring<= 400 charactersrequired
descriptionstring<= 400 characters
scriptstringrequired
is_publicbooleanread-onlyrequired
Response
application/json
{ "id": 0, "platform": 0, "student": 2147483647, "title": "string", "description": "string", "script": "string", "is_public": true }

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