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_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
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}/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": [ {} ] }

ai_mentor_orgs_trigger_create

Request

Create or modify a trigger.

Args: request: The HTTP request containing the trigger data. org: The organization/tenant identifier.

Returns: Response: The created or updated trigger details.

Raises: BadRequest: If the provided data is invalid or missing required parameters.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
Bodyrequired
templatestringrequired
slugstringrequired
parametersanyrequired
curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/trigger/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "slug": "trggr-slug-1",
    "template": "url_to_email_everyday",
    "parameters": {
      "recipients": [
        "tcook@apple.com"
      ],
      "trigger_url": "https://google.com"
    }
  }'

Responses

Bodyapplication/json
slugstringrequired
templatestring or nullread-onlyrequired
platformstring or nullread-onlyrequired
parametersany or nullread-onlyrequired
Response
application/json
{ "slug": "trggr-slug-1", "template": "url_to_email_everyday", "platform": "main", "parameters": { "recipients": [], "trigger_url": "https://google.com" } }

ai_mentor_orgs_trigger_templates_retrieve

Request

Retrieve available trigger templates.

Args: request: The HTTP request. org: The organization/tenant identifier.

Returns: Response: A dictionary of available trigger templates and their required parameters.

Raises: BadRequest: If the request is invalid.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/trigger-templates/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Dictionary of trigger templates and their required parameters

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