Knowledge Base
Your API key for authentication
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
The target folder ID of the knowledge base node
The node IDs of the knowledge base node
The keep current permission of the knowledge base node
알겠습니다.
Moved knowledge base node IDs
Failed knowledge base node IDs
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
POST /webapi/v2/knowledge_base_nodes/move/bulk HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 73
{
"targetFolderId": "text",
"nodeIds": [
"text"
],
"keepCurrentPermission": true
}{
"moved_kb_node_ids": [
"text"
],
"failed_kb_node_ids": [
"text"
]
}Your API key for authentication
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
지식베이스의 파일 이름
지식베이스의 해시태그
지식베이스의 대상 폴더 ID
지식베이스의 덮어쓰기 폴더 접근 플래그
falseIf true and a document with the same file name already exists in the target folder, overwrite it with the uploaded file instead of creating a suffixed copy. Identical files (same name, size, and content) are always skipped regardless of this flag. Not applied to ZIP uploads: each extracted entry is always created fresh under a new folder.
false지식베이스의 에이전트 플래그 보기 접근 권한
false지식베이스의 유저 플래그 보기 권한
falseWhether to use layout processing for improved document ingestion. Only used if project allows this feature.
trueWhether to use image description for improved document ingestion. Only used if project allows this feature.
trueWhether to use OCR for document processing
false알겠습니다.
Knowledge base node
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
POST /webapi/v2/knowledge_base_nodes/upload HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 558
{
"fileName": "text",
"hashtags": [
"text"
],
"targetFolderId": "text",
"isOverwriteFolderAccess": false,
"isOverwrite": false,
"accessPermissionGroups": [
{
"permissionGroupId": "text",
"accessType": "order_1_editor"
}
],
"accessAgents": [
{
"agentId": "text",
"accessType": "order_1_editor"
}
],
"accessUserFilters": [
{
"variableName": "CUSTOMER_ID",
"value": "text"
}
],
"viewAccessToAgent": false,
"viewAccessToUser": false,
"useLayout": true,
"useImageDescription": true,
"useOcr": false,
"properties": [
{
"key": "text",
"value": "text"
}
],
"notificationHooks": [
"email_on_ingestion_complete"
],
"file": "binary"
}[
{
"result": {
"id": "text",
"name": "text",
"createdAt": 1,
"createdBy": {
"id": "text",
"email": "text",
"firstName": "text",
"lastName": "text"
},
"updatedAt": 1,
"nodeType": "text",
"parentFolder": {
"id": "text",
"name": "text"
},
"breadcrumbs": [
{
"id": "text",
"name": "text"
}
],
"agentPermission": {
"accessAgents": [
{
"agentId": "text",
"accessType": "order_1_editor"
}
],
"accessPermissionGroups": [
{
"permissionGroupId": "text",
"permissionGroupName": "text",
"accessType": "order_1_editor"
}
],
"viewAccessToAgent": true
},
"userPermission": {
"ownUserIds": [
"text"
],
"customerGroups": [
"text"
],
"viewAccessToUser": true
}
}
}
]Your API key for authentication
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
S3에서 파일 업로드 요청 모델.
지식베이스의 파일 이름
지식베이스의 해시태그
지식베이스의 대상 폴더 ID
지식베이스의 폴더 덮어쓰기 접근 플래그
falseIf true and a document with the same file name already exists in the target folder, overwrite it with the uploaded file instead of creating a suffixed copy. Identical files (same name, size, and content) are always skipped regardless of this flag. Not applied to ZIP uploads: each extracted entry is always created fresh under a new folder.
false지식베이스의 에이전트 플래그 보기 권한
false지식베이스의 유저 플래그에 대한 보기 액세스
falseWhether to use layout processing for improved document ingestion. Only used if project allows this feature.
trueWhether to use image description for improved document ingestion. Only used if project allows this feature.
trueWhether to use OCR for document processing
false파일의 버킷 객체 경로
귀하의 S3 비밀 키.
귀하의 S3 액세스 키.
액세스를 위한 AWS IAM 역할 ARN
AWS IAM 역할의 외부 ID
알겠어
Knowledge base node
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
POST /webapi/v2/knowledge_base_nodes/upload_from_aws_s3 HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 658
{
"fileName": "text",
"hashtags": [
"text"
],
"targetFolderId": "text",
"isOverwriteFolderAccess": false,
"isOverwrite": false,
"accessPermissionGroups": [
{
"permissionGroupId": "text",
"accessType": "order_1_editor"
}
],
"accessAgents": [
{
"agentId": "text",
"accessType": "order_1_editor"
}
],
"accessUserFilters": [
{
"variableName": "CUSTOMER_ID",
"value": "text"
}
],
"viewAccessToAgent": false,
"viewAccessToUser": false,
"useLayout": true,
"useImageDescription": true,
"useOcr": false,
"properties": [
{
"key": "text",
"value": "text"
}
],
"notificationHooks": [
"email_on_ingestion_complete"
],
"bucketObjectPath": "text",
"awsSecretKey": "text",
"awsAccessKey": "text",
"awsIamRoleArn": "text",
"awsExternalId": "text"
}{
"result": {
"id": "text",
"name": "text",
"createdAt": 1,
"createdBy": {
"id": "text",
"email": "text",
"firstName": "text",
"lastName": "text"
},
"updatedAt": 1,
"nodeType": "text",
"parentFolder": {
"id": "text",
"name": "text"
},
"breadcrumbs": [
{
"id": "text",
"name": "text"
}
],
"agentPermission": {
"accessAgents": [
{
"agentId": "text",
"accessType": "order_1_editor"
}
],
"accessPermissionGroups": [
{
"permissionGroupId": "text",
"permissionGroupName": "text",
"accessType": "order_1_editor"
}
],
"viewAccessToAgent": true
},
"userPermission": {
"ownUserIds": [
"text"
],
"customerGroups": [
"text"
],
"viewAccessToUser": true
}
}
}Your API key for authentication
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
Azure Blob Storage에서 파일 업로드를 위한 요청 모델.
지식베이스의 파일 이름
지식베이스의 해시태그
지식베이스의 대상 폴더 ID
지식베이스의 덮어쓰기 폴더 접근 플래그
falseIf true and a document with the same file name already exists in the target folder, overwrite it with the uploaded file instead of creating a suffixed copy. Identical files (same name, size, and content) are always skipped regardless of this flag. Not applied to ZIP uploads: each extracted entry is always created fresh under a new folder.
false지식베이스의 에이전트 플래그 보기 권한
false지식베이스의 유저 플래그에 대한 보기 권한
falseWhether to use layout processing for improved document ingestion. Only used if project allows this feature.
trueWhether to use image description for improved document ingestion. Only used if project allows this feature.
trueWhether to use OCR for document processing
false파일이 위치한 Blob 컨테이너 경로
유저의 Azure Blob Storage용 연결 문자열.
확인
Knowledge base node
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
POST /webapi/v2/knowledge_base_nodes/upload_from_azure_blob HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 600
{
"fileName": "text",
"hashtags": [
"text"
],
"targetFolderId": "text",
"isOverwriteFolderAccess": false,
"isOverwrite": false,
"accessPermissionGroups": [
{
"permissionGroupId": "text",
"accessType": "order_1_editor"
}
],
"accessAgents": [
{
"agentId": "text",
"accessType": "order_1_editor"
}
],
"accessUserFilters": [
{
"variableName": "CUSTOMER_ID",
"value": "text"
}
],
"viewAccessToAgent": false,
"viewAccessToUser": false,
"useLayout": true,
"useImageDescription": true,
"useOcr": false,
"properties": [
{
"key": "text",
"value": "text"
}
],
"notificationHooks": [
"email_on_ingestion_complete"
],
"containerBlobPath": "text",
"azureConnectionString": "text"
}{
"result": {
"id": "text",
"name": "text",
"createdAt": 1,
"createdBy": {
"id": "text",
"email": "text",
"firstName": "text",
"lastName": "text"
},
"updatedAt": 1,
"nodeType": "text",
"parentFolder": {
"id": "text",
"name": "text"
},
"breadcrumbs": [
{
"id": "text",
"name": "text"
}
],
"agentPermission": {
"accessAgents": [
{
"agentId": "text",
"accessType": "order_1_editor"
}
],
"accessPermissionGroups": [
{
"permissionGroupId": "text",
"permissionGroupName": "text",
"accessType": "order_1_editor"
}
],
"viewAccessToAgent": true
},
"userPermission": {
"ownUserIds": [
"text"
],
"customerGroups": [
"text"
],
"viewAccessToUser": true
}
}
}Your API key for authentication
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
The limit of the knowledge base node
10The after of the knowledge base node
The offset of the knowledge base node
좋아요
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
POST /webapi/v2/knowledge_base_nodes/search HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1183
{
"filter_": {
"parentFolderIds": [
"text"
],
"searchTerm": "text",
"hashtags": [
"text"
],
"hashtagsSearchOperator": "text",
"combinedHashtags": [
[
"text"
]
],
"combinedHashtagsOperator": "text",
"excludingHashtags": [
"text"
],
"excludingHashtagsSearchOperator": "text",
"processState": [
"initializing"
],
"status": [
"on"
],
"nodeType": [
"file"
],
"knowledgeBaseIds": [
"text"
],
"folderIds": [
"text"
],
"ownership": [
"personal"
],
"ancestorIds": [
"text"
],
"hasFaqCandidates": true,
"sourceTypes": [
"onedrive"
],
"facetConditions": [
{
"attribute": "text",
"comparator": "eq",
"value": "text"
}
],
"latestVersionOnly": true
},
"filter": {
"parentFolderIds": [
"text"
],
"searchTerm": "text",
"hashtags": [
"text"
],
"hashtagsSearchOperator": "text",
"combinedHashtags": [
[
"text"
]
],
"combinedHashtagsOperator": "text",
"excludingHashtags": [
"text"
],
"excludingHashtagsSearchOperator": "text",
"processState": [
"initializing"
],
"status": [
"on"
],
"nodeType": [
"file"
],
"knowledgeBaseIds": [
"text"
],
"folderIds": [
"text"
],
"ownership": [
"personal"
],
"ancestorIds": [
"text"
],
"hasFaqCandidates": true,
"sourceTypes": [
"onedrive"
],
"facetConditions": [
{
"attribute": "text",
"comparator": "eq",
"value": "text"
}
],
"latestVersionOnly": true
},
"order": "updated_at_desc",
"limit": 10,
"after": "text",
"offset": 1
}{
"result": {
"nodes": [
{
"id": "text",
"name": "text",
"createdAt": 1,
"createdBy": {
"id": "text",
"email": "text",
"firstName": "text",
"lastName": "text"
},
"updatedAt": 1,
"nodeType": "text",
"parentFolder": {
"id": "text",
"name": "text"
},
"breadcrumbs": [
{
"id": "text",
"name": "text"
}
],
"agentPermission": {
"accessAgents": [
{
"agentId": "text",
"accessType": "order_1_editor"
}
],
"accessPermissionGroups": [
{
"permissionGroupId": "text",
"permissionGroupName": "text",
"accessType": "order_1_editor"
}
],
"viewAccessToAgent": true
},
"userPermission": {
"ownUserIds": [
"text"
],
"customerGroups": [
"text"
],
"viewAccessToUser": true
}
}
],
"cursor": "text",
"totalFileCount": 1,
"totalFolderCount": 1
}
}Your API key for authentication
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
The search term of the knowledge base node
The limit of the knowledge base node
10The after of the knowledge base node
The folder IDs of the knowledge base node
알겠습니다.
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
POST /webapi/v2/knowledge_base_nodes/content_search HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 89
{
"searchTerm": "text",
"limit": 10,
"after": "text",
"folderIds": [
"text"
],
"searchScope": "both"
}{
"result": {
"nodes": [
{
"id": "text",
"name": "text",
"createdAt": 1,
"createdBy": {
"id": "text",
"email": "text",
"firstName": "text",
"lastName": "text"
},
"updatedAt": 1,
"nodeType": "text",
"parentFolder": {
"id": "text",
"name": "text"
},
"breadcrumbs": [
{
"id": "text",
"name": "text"
}
],
"agentPermission": {
"accessAgents": [
{
"agentId": "text",
"accessType": "order_1_editor"
}
],
"accessPermissionGroups": [
{
"permissionGroupId": "text",
"permissionGroupName": "text",
"accessType": "order_1_editor"
}
],
"viewAccessToAgent": true
},
"userPermission": {
"ownUserIds": [
"text"
],
"customerGroups": [
"text"
],
"viewAccessToUser": true
}
}
],
"cursor": "text",
"totalFileCount": 1,
"totalFolderCount": 1
}
}Your API key for authentication
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
The search terms for page content search
The folder IDs to search within
The knowledge base IDs to search within
The hashtags to filter by
The hashtags operator (AND/OR)
ORThe hashtags to exclude
The exclude hashtags operator (AND/OR)
ORThe number of top results to return
1Whether to merge content from the same page
falseOK
Response model for page content search containing list of page content items with metadata.
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
POST /webapi/v2/knowledge_base_nodes/page_content_search HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 206
{
"searchTerms": [
"text"
],
"folderIds": [
"text"
],
"knowledgeBaseIds": [
"text"
],
"hashtags": [
"text"
],
"hashtagsOperator": "OR",
"excludeHashtags": [
"text"
],
"excludeHashtagsOperator": "OR",
"topN": 1,
"mergeSamePage": false
}{
"results": [
{
"kbId": "text",
"title": "text",
"text": "text",
"pageNo": 1
}
]
}Your API key for authentication
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
알겠습니다.
Knowledge base node
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
GET /webapi/v2/knowledge_base_nodes/{node_id} HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
{
"result": {
"id": "text",
"name": "text",
"createdAt": 1,
"createdBy": {
"id": "text",
"email": "text",
"firstName": "text",
"lastName": "text"
},
"updatedAt": 1,
"nodeType": "text",
"parentFolder": {
"id": "text",
"name": "text"
},
"breadcrumbs": [
{
"id": "text",
"name": "text"
}
],
"agentPermission": {
"accessAgents": [
{
"agentId": "text",
"accessType": "order_1_editor"
}
],
"accessPermissionGroups": [
{
"permissionGroupId": "text",
"permissionGroupName": "text",
"accessType": "order_1_editor"
}
],
"viewAccessToAgent": true
},
"userPermission": {
"ownUserIds": [
"text"
],
"customerGroups": [
"text"
],
"viewAccessToUser": true
}
}
}Your API key for authentication
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
The title of the knowledge base node
지식베이스 노드의 해시태그
The overwrite folder access flag of the knowledge base node
The view access to agent flag of the knowledge base node
The view access to user flag of the knowledge base node
확인
Knowledge base node
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
PUT /webapi/v2/knowledge_base_nodes/{node_id} HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 381
{
"title": "text",
"hashtags": [
"text"
],
"isOverwriteFolderAccess": true,
"accessPermissionGroups": [
{
"permissionGroupId": "text",
"accessType": "order_1_editor"
}
],
"accessAgents": [
{
"agentId": "text",
"accessType": "order_1_editor"
}
],
"accessUserFilters": [
{
"variableName": "CUSTOMER_ID",
"value": "text"
}
],
"viewAccessToAgent": true,
"viewAccessToUser": true,
"properties": [
{
"key": "text",
"value": "text"
}
]
}{
"result": {
"id": "text",
"name": "text",
"createdAt": 1,
"createdBy": {
"id": "text",
"email": "text",
"firstName": "text",
"lastName": "text"
},
"updatedAt": 1,
"nodeType": "text",
"parentFolder": {
"id": "text",
"name": "text"
},
"breadcrumbs": [
{
"id": "text",
"name": "text"
}
],
"agentPermission": {
"accessAgents": [
{
"agentId": "text",
"accessType": "order_1_editor"
}
],
"accessPermissionGroups": [
{
"permissionGroupId": "text",
"permissionGroupName": "text",
"accessType": "order_1_editor"
}
],
"viewAccessToAgent": true
},
"userPermission": {
"ownUserIds": [
"text"
],
"customerGroups": [
"text"
],
"viewAccessToUser": true
}
}
}Your API key for authentication
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
알겠습니다
No content
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
DELETE /webapi/v2/knowledge_base_nodes/{node_id} HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
No content
Your API key for authentication
1Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
OK
Response model for knowledge base preview containing HTML and PDF information.
HTML preview of the knowledge base
PDF preview of the knowledge base
Image preview of the knowledge base
Preview URL of the knowledge base
Total preview count of the knowledge base
0Whether the preview is hidden due to PII masking
falseInvalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
GET /webapi/v2/knowledge_base_nodes/{node_id}/preview HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
{
"html": "text",
"pdfUrl": "text",
"imageUrl": "text",
"previewUrl": "text",
"totalPreviewCount": 0,
"piiMasked": false
}Your API key for authentication
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
OK
No content
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
GET /webapi/v2/knowledge_base_nodes/{node_id}/text HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
No content
Your API key for authentication
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
OK
No content
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
GET /webapi/v2/knowledge_base_nodes/{node_id}/download HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
No content
Your API key for authentication
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
falsetruetrue알겠습니다
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
POST /webapi/v2/folders HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 302
{
"name": "text",
"parentFolderId": "text",
"followParentFolderPermission": false,
"permissionGroupEditors": [],
"permissionGroupViewers": [],
"agentEditors": [
"text"
],
"agentViewers": [
"text"
],
"userViewers": {
"customerIds": [
"text"
],
"customerGroupIds": [
"text"
]
},
"allowOtherAgentsView": true,
"allowOtherUsersView": true
}{
"id": "text",
"name": "text",
"createdAt": 1,
"updatedAt": 1,
"parentFolderId": "text",
"folderSize": 1
}Your API key for authentication
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
OK
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
GET /webapi/v2/folders/{folder_id} HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
{
"id": "text",
"name": "text",
"createdAt": 1,
"updatedAt": 1,
"parentFolderId": "text",
"folderSize": 1
}Your API key for authentication
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
좋아요
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
PUT /webapi/v2/folders/{folder_id} HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 241
{
"name": "text",
"permissionGroupEditors": [],
"permissionGroupViewers": [],
"agentEditors": [
"text"
],
"agentViewers": [
"text"
],
"userViewers": {
"customerIds": [
"text"
],
"customerGroupIds": [
"text"
]
},
"allowOtherAgentsView": true,
"allowOtherUsersView": true
}{
"id": "text",
"name": "text",
"createdAt": 1,
"updatedAt": 1,
"parentFolderId": "text",
"folderSize": 1
}Your API key for authentication
falseOptional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
OK
No content
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
DELETE /webapi/v2/folders/{folder_id} HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
No content
Your API key for authentication
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
올바른 지식베이스 ID
올바른 지식베이스 ID
알겠습니다.
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
POST /webapi/v2/knowledge_base_diff HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 34
{
"leftId": "text",
"rightId": "text"
}{
"result": [
{
"left": {
"status": "text",
"page": 1,
"line": 1,
"text": "text",
"highlight": "text"
},
"right": {
"status": "text",
"page": 1,
"line": 1,
"text": "text",
"highlight": "text"
},
"row": 1,
"comment": "text"
}
]
}Your API key for authentication
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
OK
No content
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
GET /webapi/v2/embedding_status HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
No content
Your API key for authentication
""1""Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
OK
No content
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
GET /webapi/v2/embedding_status/docs HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
No content
Your API key for authentication
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
allOK
No content
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
POST /webapi/v2/embedding_status/reset HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 15
{
"scope": "all"
}No content
Your API key for authentication
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
OK
No content
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
GET /webapi/v2/embedding_status/{kb_id}/es-count HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
No content
Your API key for authentication
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
OK
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
GET /webapi/v2/ingestion_status/{kb_id} HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
{
"status": "text",
"startedAt": 1,
"endedAt": 1,
"elapsed": 1,
"steps": [
{
"name": "text",
"subLabel": "text",
"startedAt": 1,
"endedAt": 1,
"status": "text"
}
]
}Your API key for authentication
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
다운로드할 문서의 이름
문서 파일이 성공적으로 다운로드되었습니다.
여러 문서가 발견됨
무단
금지됨
문서를 찾을 수 없습니다.
내부 서버 오류
GET /download_document_by_name/{project_id} HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 19
{
"filename": "text"
}binaryYour API key for authentication
The id of the document.
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
문서의 상세 정보를 성공적으로 가져옴
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
GET /webapi/single_document?id=text HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
{
"result": {
"id": "text",
"documentName": "text",
"createdDate": "2026-01-01",
"hashtags": [
"text"
],
"agentFeedback": {
"positiveCount": 1,
"negativeCount": 1
},
"userFeedback": {
"positiveCount": 1,
"negativeCount": 1
}
}
}Your API key for authentication
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
로컬 파일 위치
업로드 파일의 해시태그
업로드된 파일의 검색 결과에 대한 출처를 바닥글로 입력할 수 있습니다. 바닥글 텍스트는 검색 결과의 '출처' 옆에 나타납니다.
footerTitle에 연결하려는 URL을 넣을 수 있습니다.
업로드할 대상 폴더 ID입니다. 최상위 수준에 삽입하려면 Null로 설정합니다.
다른 에이전트가 이 문서를 볼 수 있도록 허용할지 여부
다른 유저가 이 문서를 볼 수 있도록 허용할지 여부
Whether to use layout processing for improved document ingestion. If null, project setting will be used.
Whether to use image description for improved document ingestion. If null, project setting will be used.
파일 업로드 성공
잘못된 요청 또는 파일 형식
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
파일 크기가 제한을 초과합니다.
Internal server error.
POST /webapi/upload_file HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 248
{
"file": "binary",
"hashtags": [
"text"
],
"footerTitle": "text",
"footerUrl": "text",
"parentFolderId": "text",
"allowOtherAgentsView": true,
"allowOtherUsersView": true,
"useLayout": true,
"useImageDescription": true,
"properties": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}{
"result": {
"id": "text",
"file_name": "text",
"hashtags": [
"text"
],
"footer": "text"
}
}Your API key for authentication
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
파일의 S3 경로. 파일 이름으로 끝나야 합니다. 버킷 이름은 포함하지 마세요.
귀하의 S3 비밀 키.
당신의 S3 액세스 키.
파일을 포함하는 S3 버킷의 이름입니다.
업로드된 파일의 검색 결과에서 정답의 출처를 각주로 작성할 수 있습니다. 각주 텍스트는 검색 결과에서 '출처' 옆에 나타납니다.
당신이 연결하고 싶은 URL을 footerTitle에 넣을 수 있습니다.
문서의 해시태그.
업로드할 타겟 폴더 ID. 최상위 수준에 삽입하려면 null로 설정합니다.
S3에서 파일이 성공적으로 업로드되었습니다.
잘못된 요청 매개변수
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
S3에서 파일을 찾을 수 없음
Internal server error.
POST /webapi/upload_from_s3 HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 201
{
"path": "text",
"secretKey": "text",
"accessKey": "text",
"bucket": "text",
"footerTitle": "text",
"footerUrl": "text",
"hashtags": [
"text"
],
"parentFolderId": "text",
"properties": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}{
"result": {
"id": "text",
"file_name": "text",
"hashtags": [
"text"
],
"footer": "text"
}
}Your API key for authentication
The document id to check the status
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
파일 상태를 성공적으로 가져왔습니다.
잘못된 작업 ID 또는 파일을 찾을 수 없음
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
GET /webapi/check_file_status?id=text HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
{
"result": {
"id": "text",
"status": "text",
"errorName": "text"
}
}Your API key for authentication
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
변경하려는 문서 ID.
지정된 문서의 새 이름.
지식베이스 이름이 성공적으로 업데이트되었습니다.
유효하지 않은 매개변수
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
POST /webapi/update_kb_name HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 31
{
"id": "text",
"filename": "text"
}{
"result": {
"id": "text",
"filename": "text"
}
}Your API key for authentication
문서를 제외할 해시태그의 쉼표로 구분된 목록.
Semantic matching에 벡터 검색을 사용하려면 'true'로 설정하고, 텍스트 기반 검색을 사용하려면 'false'로 설정합니다.
결과를 정렬할 속성 필드.
결과를 정렬할 방향(오름차순 또는 내림차순).
페이지네이션을 위한 생략된 결과 수.
반환할 최대 결과 수.
The direction to sort results in (ascending or descending).
Number of results to skip for pagination.
Maximum number of results to return.
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
제목으로 문서를 성공적으로 검색했습니다.
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
GET /webapi/search_document_by_title?query=text HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
{
"result": [
{
"id": "text",
"file_name": "text",
"page_count": 1,
"download_url": "text",
"hashtags": [
"text"
],
"score": 1,
"folder": "text",
"agentEditor": [
"text"
],
"agentViewer": [
"text"
]
}
]
}Your API key for authentication
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
배열 형식으로 삭제하려는 문서 ID들
파일이 성공적으로 삭제되었습니다.
삭제가 실패하면, 여기에 오류 메시지가 포함될 것입니다.
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
POST /webapi/delete_file HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 16
{
"ids": [
"text"
]
}{
"result": {
"ok": true
},
"errors": {}
}Your API key for authentication
Either AND or OR, logical operator used to match multiple hashtags. Defaults to OR.
ORPossible values: The on/off status of the document to filter the list.
Keyword search query to filter the list. You can use operators to run advanced searches. "TERM1 TERM2" for AND, "TERM1 OR TERM2" for OR, and "TERM\ for exact match.
Hashtag information to filter the list.
The order type of the list. FILE_NAME_ASC/DESC for file name, TYPE_ASC/DESC for file type, STATUS_ASC/DESC for on/off status, CREATED_AT_ASC/DESC for upload date.
offset allows you to specify the ranking number of the first item on the page.
limit allows you to set the number of objects returned on one page. The maximum value is 100.
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
Successfully retrieved list of documents
Error information if the request fails
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
GET /webapi/knowledge_bases HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
{
"result": {
"items": [
{
"id": "text",
"fileName": "text",
"hashtags": [
"text"
],
"autoHashtags": [
{}
],
"folder": "text",
"agentEditor": [
"text"
],
"agentViewer": [
"text"
],
"userViewer": {
"variables": {}
},
"allowOtherAgentsView": true,
"allowOtherUsersView": true
}
]
},
"errors": {}
}Your API key for authentication
The document ID that you want to preview
Pages of the document you want to preview
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
Successfully retrieved document preview
Error information if the request fails
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
GET /webapi/knowledge_base_preview?id=text&pageNo=text HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
{
"result": {
"totalPageCount": 1,
"pageNo": 1,
"css": "text",
"body": "text",
"highlightIndexes": [
1
],
"exactAnswer": "text",
"pdf": "text",
"draftjs": "text",
"highlights": {
"indexes": [
1
],
"pageIndexes": [
1
],
"__typename": "text"
},
"knowledgeBase": {
"id": "text",
"title": "text",
"__typename": "text"
},
"__typename": "text"
},
"errors": {}
}Your API key for authentication
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
The id of the document you want to update
You can type in the source of the answer as a footer for search results from the uploaded file. The footer text will appear next to 'From' in search results.
You can put the URL you want to link to the footerTitle.
You can assign the destination folder for document upload.
Whether to follow the folder's permission settings.
Specify agents that have editor permissions for the file.
Specify agents that have viewer permissions for the file.
Agents not included in viewers/editors can also view the document.
Users not included in viewers/editors can also view the document.
List of string hashtags you want to add to the document
Document updated successfully
Error information if the request fails
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
POST /webapi/update_document HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 334
{
"id": "text",
"footerTitle": "text",
"footerUrl": "text",
"folder": "text",
"followFolderPermission": true,
"agentsEditor": [
"text"
],
"agentsViewer": [
"text"
],
"userViewer": {
"customer_id": [
"text"
],
"customer_group": [
"text"
]
},
"allowOtherAgentsView": true,
"allowOtherUsersView": true,
"hashtags": [
"text"
],
"properties": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}{
"result": {
"knowledgeBase": {
"id": "text",
"hashtags": [
"text"
],
"footer": "text"
}
},
"errors": {}
}Your API key for authentication
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
Whether to turn all the status of all the knowledge bases to on (True) or off (False)
This is a list of the ids of the knowledge bases that you want to toggle.
Knowledge base statuses toggled successfully
Error information if the request fails
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
POST /webapi/toggle_documents HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 27
{
"use": true,
"ids": [
"text"
]
}{
"result": {
"knowledgeBases": [
{
"id": "text",
"status": true
}
]
},
"errors": {}
}Last updated