Skip to content

ibl-data-manager (4.84.1-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_index_orgs_users_documents_settings_retrieve

Request

Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin

Security
PlatformApiKeyAuthentication
Path
document_idstringrequired
orgstringrequired
user_idstringrequired
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/settings/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
retrain_interval_daysinteger or null[ -2147483648 .. 2147483647 ]
Response
application/json
{ "retrain_interval_days": -2147483648 }

ai_index_orgs_users_documents_settings_create

Request

Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin

Security
PlatformApiKeyAuthentication
Path
document_idstringrequired
orgstringrequired
user_idstringrequired
Body
retrain_interval_daysinteger or null[ -2147483648 .. 2147483647 ]
curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/settings/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "retrain_interval_days": -2147483648
  }'

Responses

Bodyapplication/json
retrain_interval_daysinteger or null[ -2147483648 .. 2147483647 ]
Response
application/json
{ "retrain_interval_days": -2147483648 }

ai_index_orgs_users_documents_document_from_pool_create

Request

Train a document from the document pool

Sample request:

{"document_id": 3, "to_pathway": "7c43ec09-3d37-489c-a461-8d73df1d91c7"}
Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Bodyapplication/jsonrequired
to_pathwaystringrequired

Pathway for document to be trained in.

document_idintegerrequired

The document id from pool.

curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-index/orgs/{org}/users/{user_id}/documents/document-from-pool/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "to_pathway": "string",
    "document_id": 0
  }'

Responses

Bodyapplication/json
document_idstring

Document id for document in training

task_idstring

Task id for document in training

messagestringrequired

Message of the training

errorstring
Response
application/json
{ "document_id": "string", "task_id": "string", "message": "string", "error": "string" }

ai-marketing

Operations

ai-media

Operations

ai-mentor

Operations

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