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_sessions_browser_screenshot_retrieve

Request

Endpoint to fetch the logs of a session. Logs are cached for up to 1 hour of their creation: accessing the logs after an hour will result in an empty data.

This is intentional and made to avoid cases where logs bloat our in-memory db.

Accessible to tenant admins and students.

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

Returns:

200: a SessionBrowserScreenshot object

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
session_idstring(uuid)required
user_idstringrequired
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/sessions/{session_id}/browser-screenshot/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
typestringrequired
session_idstringrequired
formatstringrequired
extstringrequired
urlstringrequired
timestring(date-time)required
Response
application/json
[ { "type": "screenshot", "session_id": "937d3d46-3048-4f9d-aa5c-ce7c51d85332", "format": "png", "ext": "png", "url": "https://example.com/screenshots/123.png", "time": "2023-01-01T12:00:00Z" } ]

ai_mentor_orgs_users_sessions_download_session_retrieve

Request

Retrieves the chat history for a session as a plain text file.

Returns: 200: txt file containing coversation

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
session_idstring(uuid)required
user_idstringrequired
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/sessions/{session_id}/download-session' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

No response body

ai_mentor_orgs_users_sessions_memory_retrieve

Request

Retrieve memory data for a specific session.

This endpoint returns the memory components (knowledge gaps, lessons learned, help requests) that were generated during the specified chat session.

Args: org: The organization/tenant identifier. user_id: The ID of the user who owns the session. session_id: The ID of the session to retrieve memory for.

Returns: Response: The memory data associated with the session.

Raises: NotFound: If the session does not exist or does not belong to the user.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
session_idstringrequired
user_idstringrequired
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/sessions/{session_id}/memory/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
memoryobjectread-onlyrequired
memory.​dataArray of objects(MemoryComponentData)read-onlyrequired
memory.​data[].​kindstring(KindEnum)
  • KnowledgeGap - KnowledgeGap
  • LessonsLearned - LessonsLearned
  • HelpRequest - HelpRequest
Enum"KnowledgeGap""LessonsLearned""HelpRequest"
memory.​data[].​contentstringrequired
updated_atstringread-onlyrequired
session_idstringread-onlyrequired
Response
application/json
{ "memory": { "data": [] }, "session_id": "session-uuid-4bfa-8b50-a9bb3ab33e71", "updated_at": "2024-01-15T10:30:00Z" }

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