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_tasks_retrieve

Request

Check the status of a document training task.

This endpoint retrieves the current status of an asynchronous document training task that was previously initiated.

Args: request: The HTTP request. org: Organization key identifier. task_id: The ID of the training task to check.

Returns: Response: The current status of the document training task, which can be "pending", "completed", or "failed".

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

Responses

Bodyapplication/json
statusstringrequired

Status of the training

messagestringrequired

Message of the training

Response
application/json
{ "status": "pending", "message": "Training document pending" }

ai_index_orgs_users_documents_train_create

Request

Train a document through a worker process.

This endpoint queues larger documents for training through a worker process, which is more suitable for handling documents that would take too long to process directly.

Args: request: The HTTP request containing the document information. org: Organization key identifier.

Returns: Response: A confirmation that the document was queued for training, including a task ID for tracking the progress.

Raises: ValidationError: If the request data is invalid. BadRequest: If there was an error processing the document.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Bodyrequired
pathwaystringrequired

Pathway for document to be trained in

urlstring

Url of the document to be trained

textstring

Search text for wikipedia

typestringrequired

Type of document e.g file

translateboolean

If file should be translated

Default false
filestring(binary)

File to be trained

accessstring

Accessibilityto the file

Default "private"
branchstring

Branch of the repository

google_drive_auth_dataany

Authentication and scoped details of google drive

dropbox_auth_dataany

Authentication and scoped details of dropbox

crawler_max_depthinteger

The max depth of the crawler

crawler_max_pages_limitinteger

The max pages limit of the crawler

crawler_max_concurrencyinteger

The max concurrency of the crawler

crawler_match_patternsArray of strings

The patterns that the crawler should use to match urls. Patterns may be a glob pattern or a full regex pattern. Indicate the specified type in crawler_use_glob_matching.

crawler_use_glob_matchingboolean

Whether to use glob patterns for the crawler

curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-index/orgs/{org}/users/{user_id}/documents/train/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: multipart/form-data' \
  -F pathway=string \
  -F url=string \
  -F text=string \
  -F type=string \
  -F translate=false \
  -F file=string \
  -F access=private \
  -F branch=string \
  -F google_drive_auth_data=null \
  -F dropbox_auth_data=null \
  -F crawler_max_depth=0 \
  -F crawler_max_pages_limit=0 \
  -F crawler_max_concurrency=0 \
  -F crawler_match_patterns=string \
  -F crawler_use_glob_matching=true

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
[ { "task_id": "4194d20c-37d5-4148-882f-f7d2d91f7769", "document_id": "doc-123456", "message": "Document received. Your request to train is queued" } ]

ai_index_orgs_users_documents_train_retriever_create

Request

Train a document directly without using a worker.

This endpoint is designed for training smaller documents directly without queuing them through a worker process. For larger documents, use the TrainDocumentView endpoint instead.

Args: request: The HTTP request containing the document information. org: Organization key identifier.

Returns: Response: A confirmation that the document was trained successfully.

Raises: ValidationError: If the request data is invalid. BadRequest: If the document training failed.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Bodyrequired
pathwaystringrequired

Pathway for document to be trained in

urlstringrequired

Url of the document to be trained

curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-index/orgs/{org}/users/{user_id}/documents/train/retriever/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: multipart/form-data' \
  -F pathway=string \
  -F url=string

Responses

Bodyapplication/json
detailstringrequired

Status of the training

Response
application/json
{ "detail": "Document trained successfully" }

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