Skip to content
API Reference/
/
ai_mentor_orgs_users_extr...

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

ai_mentor_orgs_users_export_chathistory_create

Request

Initiates a background task to export the user's chat history.

Returns:

200: task id.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/export-chathistory/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
task_idstringrequired
Response
application/json
{
  "task_id": "307be194-2351-44ff-8d7b-24660fd9ec34"
}

ai_mentor_orgs_users_extracted_memories_retrieve

Request

Returns extracted memory for a user. This is the memory that the user tells the mentor to remember or is inferred from conversations.

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

Responses

Bodyapplication/json
modestringread-onlyrequired
namestring
emailstring or nullread-onlyrequired
unique_idstring(uuid)
usernamestring or nullread-onlyrequired
platformstring or nullread-onlyrequired
mentorstring or nullread-onlyrequired
session_idstring or nullread-onlyrequired
catalog_item_typestring or nullread-onlyrequired
catalog_item_idstring or nullread-onlyrequired
entriesArray of objects(UserMemoryEntry)required
entries[].​unique_idstring(uuid)
entries[].​keystringrequired
entries[].​valuestring or null
entries[].​inserted_atstringread-onlyrequired
entries[].​updated_atstringread-onlyrequired
entries[].​expires_atstring or nullread-onlyrequired
entries[].​categorystring or nullread-onlyrequired
inserted_atstringread-onlyrequired
updated_atstringread-onlyrequired
is_auto_generatedboolean
categorystring or null
Response
application/json
{
  "mode": "string",
  "name": "string",
  "email": "string",
  "unique_id": "677cf8c4-9b37-4a4b-b000-2ee947357c3a",
  "username": "string",
  "platform": "string",
  "mentor": "string",
  "session_id": "string",
  "catalog_item_type": "string",
  "catalog_item_id": "string",
  "entries": [
    { … }
  ],
  "inserted_at": "string",
  "updated_at": "string",
  "is_auto_generated": true,
  "category": "string"
}

ai_mentor_orgs_users_filtered_memories_list

Request

Retrieve a list of memories based on filter conditions. Only accessible to tenant admins.

Returns: Response: A paginated list of memories. Put your queries using the parameters in the query parameters. For example, to search a mentor's regular mode memory, use the following url:

https://base.manager.iblai.app/api/ai-mentor/orgs/your-org/users/your-user/filtered-memories/?mentor=f81fc856-fd8f-4e6b-9d3b-72aa68279c40&mode=regular&username=another-user

Raises: NotFound: If the query is invalid.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Query
categorystring

a string of category to filter memories

end_datestring

ISO date for end date (optional)

mentorstring

the mentor unique id which the memory is linked to

modestring

mode which the memory applies to. can be guided, regular or all

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

platformstring

the platform which the memory is linked to

sessionstring

the session id which the memory is linked to

start_datestring

ISO date for start date (optional)

usernamestring

the username of the memories

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/filtered-memories/?category=string&end_date=string&mentor=string&mode=string&page=0&page_size=0&platform=string&session=string&start_date=string&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(UserMemory)required
results[].​modestringread-onlyrequired
results[].​namestring
results[].​emailstring or nullread-onlyrequired
results[].​unique_idstring(uuid)
results[].​usernamestring or nullread-onlyrequired
results[].​platformstring or nullread-onlyrequired
results[].​mentorstring or nullread-onlyrequired
results[].​session_idstring or nullread-onlyrequired
results[].​catalog_item_typestring or nullread-onlyrequired
results[].​catalog_item_idstring or nullread-onlyrequired
results[].​entriesArray of objects(UserMemoryEntry)required
results[].​entries[].​unique_idstring(uuid)
results[].​entries[].​keystringrequired
results[].​entries[].​valuestring or null
results[].​entries[].​inserted_atstringread-onlyrequired
results[].​entries[].​updated_atstringread-onlyrequired
results[].​entries[].​expires_atstring or nullread-onlyrequired
results[].​entries[].​categorystring or nullread-onlyrequired
results[].​inserted_atstringread-onlyrequired
results[].​updated_atstringread-onlyrequired
results[].​is_auto_generatedboolean
results[].​categorystring or null
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