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/

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations

ai_mentor_orgs_users_sessions_create

Request

Retrieve or create a chat session with a mentor.

Passing null as tools results in using all tools assigned to the mentor. To specify that no tools be used, pass an empty list.

Args: request: HTTP request containing mentor details. org: Organization key identifier. user_id (optional): Username for authentication (if required by the mentor).

Returns: Response: JSON object containing the session ID.

Raises: Http404: If the mentor is not found. ValidationError: If the username is invalid. ValidationError: If one or more tool slugs are invalid.

Path
orgstringrequired
user_idstringrequired
Bodyrequired
mentorstringrequired

Name of mentor

toolsArray of strings

List of tools slugs to use. Passing null will use all tools assigned to the mentor. For no tools, pass an empty list.

curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/sessions/' \
  -H 'Content-Type: application/json' \
  -d '{
    "mentor": "ai-mentor"
  }'

Responses

Bodyapplication/json
session_idstring(uuid)required
toolsArray of objects(ToolResponse)required
tools[].​idintegerread-onlyrequired
tools[].​namestring<= 500 charactersrequired
tools[].​display_namestring<= 255 characters
tools[].​slugstring<= 50 characters^[-a-zA-Z0-9_]+$
tools[].​descriptionstring or null
tools[].​metadataany or null
tools[].​allow_retriever_mentorsboolean
tools[].​allow_openai_agentboolean
tools[].​allow_google_agentboolean
Response
application/json
{ "session_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "tools": [ {} ] }

Request

Fetches chat messages for a specific session.

Path
orgstringrequired
session_idstring(uuid)required
user_idstringrequired
Query
shareboolean
Default false
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/sessions/{session_id}/?share=false'

Responses

Bodyapplication/json
countintegerrequired
titlestringrequired
proactive_promptstringrequired
mentor_unique_idstringrequired
platform_keystringrequired
previousstringrequired
nextstringrequired
resultsArray of objectsrequired
Response
application/json
{ "count": 0, "title": "string", "proactive_prompt": "string", "mentor_unique_id": "string", "platform_key": "string", "previous": "string", "next": "string", "results": [ null ] }

ai_mentor_orgs_users_sessions_update

Request

Update the title of a chat session and its tools

Path
orgstringrequired
session_idstring(uuid)required
user_idstringrequired
Body
titlestring
toolsArray of strings

List of tools slugs to use

Default []
curl -i -X PUT \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/sessions/{session_id}/' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "New Title",
    "tools": [
      "web-search",
      "image-generation"
    ]
  }'

Responses

Bodyapplication/json
detailstringrequired
Response
application/json
{ "title": "New Title", "tools": [ "web-search", "image-generation" ] }
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations