Skip to content
API Reference/
/
ai_mentor_orgs_users_down...

ibl-data-manager (4.84.1-ai-plus)

API for iblai

Download OpenAPI description
ibl.json
ibl.yaml
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

Remove mentor from disclaimer

Request

Remove a mentor from a disclaimer with mentor scope. Only platform admins can perform this action. Validates that at least one mentor remains after removal.

Security
PlatformApiKeyAuthentication
Path
idintegerrequired

A unique integer value identifying this disclaimer.

orgstringrequired
user_idstringrequired
Body
required
mentor_idstring<= 255 charactersrequired

The unique_id of the mentor to remove from the disclaimer.

curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/disclaimers/{id}/remove-mentor/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "mentor_id": "string"
  }'

Responses

Bodyapplication/json
idintegerread-onlyrequired
scopestring(ScopeEnum)
  • platform - Platform
  • mentor - Mentor
Enum"platform""mentor"
platformintegerread-onlyrequired

Platform to which the disclaimer applies.

contentstringrequired
titlestring<= 120 characters
activeboolean
created_atstring(date-time)read-onlyrequired
updated_atstring(date-time)read-onlyrequired
has_agreedbooleanread-onlyrequired
platform_keystringread-onlyrequired
mentorsArray of strings(uuid)
Response
application/json
{
  "id": 0,
  "scope": "platform",
  "platform": 0,
  "content": "string",
  "title": "string",
  "active": true,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "has_agreed": true,
  "platform_key": "string",
  "mentors": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ]
}

ai_mentor_orgs_users_downloads_tasks_retrieve

Request

Retrieves the chat history for a user if the export task is ready.

This Endpoint to download user chathistory.

Accessible to tenant admins and students.

Returns:

200: When task is not ready.

200: chat history object

400: When data is not valid.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
task_idstring(uuid)required
user_idstringrequired
Query
to_csvboolean

Choose download in csv or not

Default false
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/downloads/tasks/{task_id}/?to_csv=false' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
typestringrequired
contentstringrequired
timestampstring(date-time)required
Response
application/json
{
  "state": "task_not_ready"
}

ai_mentor_orgs_users_edx_memory_list

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
orgstringrequired
user_idstringrequired
Query
course_idstring
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.

studentinteger[ 0 .. 2147483647 ]

edX user ID

usernamestring
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/edx-memory/?course_id=string&ordering=string&page=0&page_size=0&student=2147483647&username=string' \
  -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(UserEdxMemory)required
results[].​idintegerread-onlyrequired
results[].​usernamestringread-onlyrequired
results[].​studentinteger[ 0 .. 2147483647 ]required

edX user ID

results[].​course_idstring<= 200 charactersrequired
results[].​dataany

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

results[].​date_createdstring(date-time)read-onlyrequired
results[].​last_modifiedstring(date-time)read-onlyrequired
Response
application/json
{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    { … }
  ]
}

ai-prompt

Operations

analytics

Operations

career

Operations

catalog

Operations

core

Operations

credentials

Operations

custom-domains

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

Operations
Copyright © ibl.ai | support@iblai.zendesk.com