Skip to content
API Reference/
/
ai_mentor_orgs_users_mcp_...

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_mcp_servers_partial_update

Request

ViewSet for MCP Servers.

Allows platform admins to list, create, retrieve, update, and delete MCP servers.

Permissions: - Accessible to tenant admins.

Security
PlatformApiKeyAuthentication
Path
idintegerrequired

A unique integer value identifying this mcp server.

orgstringrequired
user_idstringrequired
Body
namestring<= 255 characters
urlstring(uri)<= 200 characters

The url of the MCP server.

imagestring or null(uri)
transportstring(TransportEnum)
  • sse - Sse
  • websocket - Websocket
  • streamable_http - Streamable Http
Enum"sse""websocket""streamable_http"
extra_headersany

Headers to send to the MCP server. Useful for authentication,

is_featuredboolean

Featured mcp servers will be accessible to all other tenants.

curl -i -X PATCH \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/mcp-servers/{id}/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "url": "http://example.com",
    "image": "http://example.com",
    "transport": "sse",
    "extra_headers": null,
    "is_featured": true
  }'

Responses

Bodyapplication/json
idintegerread-onlyrequired
platformintegerread-onlyrequired
namestring<= 255 charactersrequired
urlstring(uri)<= 200 charactersrequired

The url of the MCP server.

imagestring or null(uri)
transportstring(TransportEnum)
  • sse - Sse
  • websocket - Websocket
  • streamable_http - Streamable Http
Enum"sse""websocket""streamable_http"
extra_headersany

Headers to send to the MCP server. Useful for authentication,

platform_keystringread-onlyrequired
is_featuredboolean

Featured mcp servers will be accessible to all other tenants.

created_atstring(date-time)read-onlyrequired
updated_atstring(date-time)read-onlyrequired
Response
application/json
{
  "id": 0,
  "platform": 0,
  "name": "string",
  "url": "http://example.com",
  "image": "http://example.com",
  "transport": "sse",
  "extra_headers": null,
  "platform_key": "string",
  "is_featured": true,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

ai_mentor_orgs_users_mcp_servers_destroy

Request

ViewSet for MCP Servers.

Allows platform admins to list, create, retrieve, update, and delete MCP servers.

Permissions: - Accessible to tenant admins.

Security
PlatformApiKeyAuthentication
Path
idintegerrequired

A unique integer value identifying this mcp server.

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

Responses

No response body

ai_mentor_orgs_users_memories_list

Request

Retrieve a list of memories based on filter conditions.

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/memories/?mentor=f81fc856-fd8f-4e6b-9d3b-72aa68279c40&mode=regular

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)

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/memories/?category=string&end_date=string&mentor=string&mode=string&page=0&page_size=0&platform=string&session=string&start_date=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