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_edx_memory_retrieve

Request

Endpoints to fetch and delete Edx stored Memory information stored for a user and a corresponding edx course they have interracted with. This information is passed to the corresponding mentor so the mentor has context information about the course and unit that the user last interracted with.

There can be only one UserEdxMemory instance per student and course_id.

Url Args: org (str): The organization's platform key. user_id (str): The username identifier of the individual.

Returns:

200: A paginated list of UserEdxMemory objects

Examples:

  • List all memories GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/

    Request: None Response: { "count": 0, "next": null, "previous": null, "results": [{ "student": 1, "course_id": "course-v1:main+CARBON+2024_Fall", "data": {}, "date_created": "2024-06-25T15:30:26.257140", "last_modified": "2024-06-25T15:30:26.257140" }] }

  • Get a single UserEdxMemory object GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/1/

    Request: None Response: { "student": 1, "course_id": "course-v1:main+CARBON+2024_Fall", "data": {}, "date_created": "2024-06-25T15:30:26.257140", "last_modified": "2024-06-25T15:30:26.257140" }

Security
PlatformApiKeyAuthentication
Path
idintegerrequired

A unique integer value identifying this user edx memory.

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

Responses

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

edX user ID

course_idstring<= 200 charactersrequired
dataany

The course data to be stored. This includes the current page and the blocks that have been visited.

date_createdstring(date-time)read-onlyrequired
last_modifiedstring(date-time)read-onlyrequired
Response
application/json
{ "id": 0, "username": "string", "student": 2147483647, "course_id": "string", "data": null, "date_created": "2019-08-24T14:15:22Z", "last_modified": "2019-08-24T14:15:22Z" }

ai_mentor_orgs_users_edx_memory_destroy

Request

Endpoints to fetch and delete Edx stored Memory information stored for a user and a corresponding edx course they have interracted with. This information is passed to the corresponding mentor so the mentor has context information about the course and unit that the user last interracted with.

There can be only one UserEdxMemory instance per student and course_id.

Url Args: org (str): The organization's platform key. user_id (str): The username identifier of the individual.

Returns:

200: A paginated list of UserEdxMemory objects

Examples:

  • List all memories GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/

    Request: None Response: { "count": 0, "next": null, "previous": null, "results": [{ "student": 1, "course_id": "course-v1:main+CARBON+2024_Fall", "data": {}, "date_created": "2024-06-25T15:30:26.257140", "last_modified": "2024-06-25T15:30:26.257140" }] }

  • Get a single UserEdxMemory object GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/1/

    Request: None Response: { "student": 1, "course_id": "course-v1:main+CARBON+2024_Fall", "data": {}, "date_created": "2024-06-25T15:30:26.257140", "last_modified": "2024-06-25T15:30:26.257140" }

Security
PlatformApiKeyAuthentication
Path
idintegerrequired

A unique integer value identifying this user edx memory.

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

Responses

No response body

ai_mentor_orgs_users_elevenlabs_voice_list

Request

Retrieve a list of Elevenlabs voices available to a user.

This endpoint returns both custom voices created by the user and premade voices available to all users.

Args: request: The HTTP request. org: The organization/tenant identifier. user_id: The ID of the user to retrieve voices for.

Returns: Response: A list of available Elevenlabs voices.

Raises: NotFound: If the specified user does not exist.

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}/elevenlabs-voice/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/jsonArray [
namestring<= 255 charactersrequired
owner_studentstring or nullread-onlyrequired
languagestring<= 255 characters
is_premadeboolean
descriptionstring
sample_audio_urlstring or nullread-onlyrequired
]
Response
application/json
[ [ {}, {}, {} ] ]

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