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_index_orgs_users_documents_destroy

Request

Delete a specific document embedding.

This endpoint removes a document embedding from the system, including untraining it from any associated pathways.

Args: request: The HTTP request. org: Organization key identifier. document_id: The ID of the document embedding to delete.

Returns: Response: An empty response with a 204 status code if successful.

Raises: NotFound: If the specified document embedding does not exist.

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

Responses

Document successfully deleted

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-marketing

Operations

ai-media

Operations

ai-mentor

Operations

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