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_ai_generated_images_retrieve

Request

Endpoint to view and delete AI generated images for a user.

AI Generated images are images generated during chat with AI. They are cached to allow retrieval and deletion.

optional filtering parameters allowed are

  • username: The username of the user for which this image was stored.
  • provider: The provider used to generate the image. eg. openai, nvidia (nim), replicate.
  • model: the text to image model on the provider used to generate the image.

This endpoint is accessible to both students and platform admins.

Security
PlatformApiKeyAuthentication
Path
idintegerrequired

A unique integer value identifying this ai generated image.

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

Responses

Bodyapplication/json
idintegerread-onlyrequired
userinteger[ 0 .. 2147483647 ]required

edX user ID

imagestring(uri)required
platformintegerrequired
promptstring
modelstring<= 255 characters
providerstring<= 255 characters
date_createdstring(date-time)read-onlyrequired
Response
application/json
{ "id": 0, "user": 2147483647, "image": "http://example.com", "platform": 0, "prompt": "string", "model": "string", "provider": "string", "date_created": "2019-08-24T14:15:22Z" }

ai_mentor_orgs_users_ai_generated_images_destroy

Request

Endpoint to view and delete AI generated images for a user.

AI Generated images are images generated during chat with AI. They are cached to allow retrieval and deletion.

optional filtering parameters allowed are

  • username: The username of the user for which this image was stored.
  • provider: The provider used to generate the image. eg. openai, nvidia (nim), replicate.
  • model: the text to image model on the provider used to generate the image.

This endpoint is accessible to both students and platform admins.

Security
PlatformApiKeyAuthentication
Path
idintegerrequired

A unique integer value identifying this ai generated image.

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

Responses

No response body

ai_mentor_orgs_users_ai_user_profile_memory_list

Request

Endpoint to get a list of AI user profile memory entries or to add an entry.

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}/ai-user-profile-memory/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/jsonArray [
tagstringread-onlyrequired
detailstring or null
]
Response
application/json
[ { "tag": "string", "detail": "string" } ]

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