Skip to content
API Reference
/
ai-index
/
ai_index_orgs_users_documents_update

ibl-data-manager (3.59.0-ai-plus)

API for iblai

Download OpenAPI description
ibl.json
ibl.yaml
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_retrieve

Request

Retrieve details of a specific document embedding.

This endpoint returns detailed information about a specific document embedding identified by its ID.

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

Returns: Response: Detailed information about the document embedding.

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

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}/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
idintegerread-onlyrequired
metadataany or null
document_namestring or null
document_typestring or null
training_status(TrainingStatusEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
One of:
  • trained - Trained
  • failed - Failed
  • pending - Pending
  • untrained - Untrained
string or null(TrainingStatusEnum)
  • trained - Trained
  • failed - Failed
  • pending - Pending
  • untrained - Untrained
Enum"trained""failed""pending""untrained"
pathwaystringrequired
urlstring or null
tokensinteger or null(int64)[ -9223372036854776000 .. 9223372036854776000 ]
platform_keystringrequired
is_trainedboolean
access(AccessEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
One of:
  • public - Public
  • private - Private
string or null(AccessEnum)
  • public - Public
  • private - Private
Enum"public""private"
crawler_max_depthinteger or null[ -2147483648 .. 2147483647 ]
crawler_max_pages_limitinteger or null[ -2147483648 .. 2147483647 ]
crawler_max_concurrencyinteger or null[ -2147483648 .. 2147483647 ]
crawler_match_patternsany

List of 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
Response
application/json
{
  "id": 1,
  "document_name": "CareerClustersPathways_0",
  "document_type": "pdf",
  "pathway": "test-pathway",
  "url": "https://example.com/files/CareerClustersPathways_0.pdf",
  "tokens": 46578,
  "platform_key": "main",
  "access": "public",
  "is_trained": true
}

ai_index_orgs_users_documents_update

Request

Update a specific document embedding.

This endpoint allows updating various properties of a document embedding, including its name, type, pathway, and training status.

Args: request: The HTTP request containing the updated document data. org: Organization key identifier. document_id: The ID of the document embedding to update.

Returns: Response: The updated document embedding information.

Raises: BadRequest: If the provided data is invalid. NotFound: If the specified document embedding does not exist.

Security
PlatformApiKeyAuthentication
Path
document_idstringrequired
orgstringrequired
user_idstringrequired
Body
required
document_namestring

The name of the document

document_typestring

The type of the document

pathwaystringrequired

The pathway to retrain the document in

urlstring

The url of the document

trainboolean

The type of the document

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

accessstring
  • public - Public
  • private - Private
Enum"public""private"
google_drive_auth_dataany

Authentication and scoped details of google drive.

dropbox_auth_dataany

Authentication and scoped details of dropbox

curl -i -X PUT \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: multipart/form-data' \
  -F document_name=string \
  -F document_type=string \
  -F pathway=string \
  -F url=string \
  -F train=true \
  -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 \
  -F access=public \
  -F google_drive_auth_data=null \
  -F dropbox_auth_data=null

Responses

Bodyapplication/json
idintegerread-onlyrequired
metadataany or null
document_namestring or null
document_typestring or null
training_status(TrainingStatusEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
One of:
  • trained - Trained
  • failed - Failed
  • pending - Pending
  • untrained - Untrained
string or null(TrainingStatusEnum)
  • trained - Trained
  • failed - Failed
  • pending - Pending
  • untrained - Untrained
Enum"trained""failed""pending""untrained"
pathwaystringrequired
urlstring or null
tokensinteger or null(int64)[ -9223372036854776000 .. 9223372036854776000 ]
platform_keystringrequired
is_trainedboolean
access(AccessEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
One of:
  • public - Public
  • private - Private
string or null(AccessEnum)
  • public - Public
  • private - Private
Enum"public""private"
crawler_max_depthinteger or null[ -2147483648 .. 2147483647 ]
crawler_max_pages_limitinteger or null[ -2147483648 .. 2147483647 ]
crawler_max_concurrencyinteger or null[ -2147483648 .. 2147483647 ]
crawler_match_patternsany

List of 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
Response
application/json
{
  "id": 1,
  "document_name": "Updated Document Name",
  "document_type": "pdf",
  "pathway": "test-pathway",
  "url": "https://example.com/files/updated_document.pdf",
  "tokens": 46578,
  "platform_key": "main",
  "is_trained": true,
  "access": "public"
}

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-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
Copyright © ibl.ai | support@iblai.zendesk.com