Knowledge_bases
Knowledge base related APIs
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
알겠습니다.
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"
}
]
}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"
}binary단일 문서의 모든 상세 정보를 얻는 방법입니다.
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
문서의 상세 정보를 성공적으로 가져옴
GET /webapi/single_document HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
문서의 상세 정보를 성공적으로 가져옴
{
"result": {
"id": "text",
"documentName": "text",
"createdDate": "2025-08-26",
"hashtags": [
"text"
],
"agentFeedback": {
"positiveCount": 1,
"negativeCount": 1
},
"userFeedback": {
"positiveCount": 1,
"negativeCount": 1
}
}
}이 API 메서드는 Cognitive Search를 위해 문서를 업로드할 수 있게 해줍니다. 업로드 가능한 파일 형식: PDF, TXT, MS Word, PowerPoint, Excel, HTM 및 HTML. 연결된 리소스가 있는 HTML 파일을 업로드하려면, 업로드 전에 상대적으로 연결된 리소스와 함께 ZIP 파일로 압축하십시오.
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로 설정합니다.
다른 에이전트가 이 문서를 볼 수 있도록 허용할지 여부
다른 유저가 이 문서를 볼 수 있도록 허용할지 여부
파일 업로드 성공
잘못된 요청 또는 파일 형식
파일 크기가 제한을 초과합니다.
POST /webapi/upload_file HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 156
{
"file": "binary",
"hashtags": [
"text"
],
"footerTitle": "text",
"footerUrl": "text",
"parentFolderId": "text",
"allowOtherAgentsView": true,
"allowOtherUsersView": true
}{
"result": {
"id": "text",
"file_name": "text",
"hashtags": [
"text"
],
"footer": "text"
}
}이 API는 S3에 저장된 문서를 Cognitive Search로 전송할 수 있게 합니다. 이 문서들은 대시보드에 지식베이스 문서로 표시됩니다. 사용 가능한 파일 형식은 "문서 업로드" 섹션과 동일합니다.
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에서 파일이 성공적으로 업로드되었습니다.
잘못된 요청 매개변수
S3에서 파일을 찾을 수 없음
POST /webapi/upload_from_s3 HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 153
{
"path": "text",
"secretKey": "text",
"accessKey": "text",
"bucket": "text",
"footerTitle": "text",
"footerUrl": "text",
"hashtags": [
"text"
],
"parentFolderId": "text"
}{
"result": {
"id": "text",
"file_name": "text",
"hashtags": [
"text"
],
"footer": "text"
}
}API를 통해 문서를 업로드하면, 변환, 구문 분석 및 벡터로 임베딩됩니다. 이 API는 업로드 중인 문서의 프로세스 상태를 보여줍니다.
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 또는 파일을 찾을 수 없음
GET /webapi/check_file_status HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
{
"result": {
"id": "text",
"status": "text",
"errorName": "text"
}
}이 API는 업로드된 문서의 이름을 업데이트할 수 있습니다.
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.
지정된 문서의 새 이름.
지식베이스 이름이 성공적으로 업데이트되었습니다.
유효하지 않은 매개변수
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"
}
}이 API는 문서의 내용이 아닌 제목으로 문서를 검색할 수 있게 합니다.
The search term for document titles.
Comma-separated list of hashtags to filter documents by.
Complex hashtag filtering using semicolons to separate groups and commas to separate tags within a group (e.g., "a,b;c,d").
Comma-separated list of hashtags to exclude documents by.
Set to 'true' to use vector search for semantic matching, or 'false' for text-based search.
The property field to sort results by.
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
제목으로 문서를 성공적으로 검색했습니다.
GET /webapi/search_document_by_title 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"
]
}
]
}이 API는 업로드된 파일을 삭제할 수 있게 해줍니다.
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들
파일이 성공적으로 삭제되었습니다.
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": {}
}This API lets you list out the uploaded documents.
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
GET /webapi/knowledge_bases HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
Successfully retrieved list of documents
{
"result": {
"items": [
{
"id": "text",
"fileName": "text",
"hashtags": [
"text"
],
"autoHashtags": [
{}
],
"folder": "text",
"agentEditor": [
"text"
],
"agentViewer": [
"text"
],
"userViewer": {
"variables": {}
},
"allowOtherAgentsView": true,
"allowOtherUsersView": true
}
]
},
"errors": {}
}This API lets you preview the uploaded documents.
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
Your API key can be found in your dashboard Settings menu, under the General tab.
Successfully retrieved document preview
GET /webapi/knowledge_base_preview HTTP/1.1
Host: backend.alli.ai
API-KEY: text
Accept: */*
Successfully retrieved document preview
{
"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": {}
}This API lets you update hashtags, footer title, and footer title link for a 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
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.
List of string hashtags you want to add to the document
Document updated successfully
POST /webapi/update_document HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 73
{
"id": "text",
"footerTitle": "text",
"footerUrl": "text",
"hashtags": [
"text"
]
}Document updated successfully
{
"result": {
"knowledgeBase": {
"id": "text",
"hashtags": [
"text"
],
"footer": "text"
}
},
"errors": {}
}This API lets you change the status of many documents (AKA knowledge bases) at once
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
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"
]
}Knowledge base statuses toggled successfully
{
"result": {
"knowledgeBases": [
{
"id": "text",
"status": true
}
]
},
"errors": {}
}Was this helpful?