> For the complete documentation index, see [llms.txt](https://docs.allganize.ai/api-reference/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.allganize.ai/api-reference/ja-1/knowledge-base.md).

# Knowledge Base

User related APIs

## 回答生成ノードを移動する

> This API allows you to move multiple knowledge base documents and/or folders to a target folder in bulk.\
> \
> \## Headers\
> \
> \- API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.\
> \- AGENT-EMAIL (string, optional): The email address of the agent performing the API call.\
> \- USER-EMAIL (string, optional): The email address to associate with the user.\
> \- OWN-USER-ID (string, optional): The user ID to identify or create a user.\
> \
> \## Request Body\
> \
> \- targetFolderId (string, required): The target folder ID to move nodes to.\
> \- nodeIds (array\[string], required): List of node IDs (KnowledgeBase or Folder) to move.\
> \- keepCurrentPermission (boolean, required): Whether to keep the current permissions of the moved nodes.

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"KnowledgeBase","description":"User related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}},"schemas":{"MoveKnowledgeBaseNodesResponse":{"properties":{"moved_kb_node_ids":{"description":"Moved knowledge base node IDs","items":{"type":"string"},"title":"Moved Kb Node Ids","type":"array"},"failed_kb_node_ids":{"description":"Failed knowledge base node IDs","items":{"type":"string"},"title":"Failed Kb Node Ids","type":"array"}},"required":["moved_kb_node_ids","failed_kb_node_ids"],"title":"MoveKnowledgeBaseNodesResponse","type":"object"},"MoveKnowledgeBaseNodesRequest":{"properties":{"targetFolderId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The target folder ID of the knowledge base node","title":"Targetfolderid"},"nodeIds":{"description":"The node IDs of the knowledge base node","items":{"type":"string"},"title":"Nodeids","type":"array"},"keepCurrentPermission":{"description":"The keep current permission of the knowledge base node","title":"Keepcurrentpermission","type":"boolean"}},"required":["targetFolderId","nodeIds","keepCurrentPermission"],"title":"MoveKnowledgeBaseNodesRequest","type":"object"}}},"paths":{"/webapi/v2/knowledge_base_nodes/move/bulk":{"post":{"operationId":"django_server_knowledge_base_views_rest_knowledge_base_node_api_move_knowledge_base_nodes","summary":"回答生成ノードを移動する","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}],"responses":{"200":{"description":"正常に移動されました。","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MoveKnowledgeBaseNodesResponse"}}}},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication failed. The API-KEY header is missing or invalid."},"403":{"description":"Access denied. The project is inactive or the request IP is not allowed."},"500":{"description":"Internal server error."}},"description":"This API allows you to move multiple knowledge base documents and/or folders to a target folder in bulk.\n\n## Headers\n\n- API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.\n- AGENT-EMAIL (string, optional): The email address of the agent performing the API call.\n- USER-EMAIL (string, optional): The email address to associate with the user.\n- OWN-USER-ID (string, optional): The user ID to identify or create a user.\n\n## Request Body\n\n- targetFolderId (string, required): The target folder ID to move nodes to.\n- nodeIds (array[string], required): List of node IDs (KnowledgeBase or Folder) to move.\n- keepCurrentPermission (boolean, required): Whether to keep the current permissions of the moved nodes.","tags":["KnowledgeBase"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MoveKnowledgeBaseNodesRequest"}}},"required":true}}}}}
```

## ドキュメントをアップロードする

> ドキュメントメニュー内にドキュメントをアップロードします。

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"KnowledgeBase","description":"User related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}},"schemas":{"KnowledgeBaseNodeResponse":{"properties":{"result":{"anyOf":[{"$ref":"#/components/schemas/KnowledgeBaseNodeFolder"},{"$ref":"#/components/schemas/KnowledgeBaseNodeFile"}],"description":"Knowledge base node","title":"Result"}},"required":["result"],"title":"KnowledgeBaseNodeResponse","type":"object"},"KnowledgeBaseNodeFolder":{"properties":{"id":{"description":"knowledge base node id","title":"Id","type":"string"},"name":{"description":"knowledge base node name","title":"Name","type":"string"},"createdAt":{"description":"knowledge base node created at","title":"Createdat","type":"number"},"createdBy":{"anyOf":[{"$ref":"#/components/schemas/CreatedByAgent"},{"type":"null"}],"description":"agent who created this node"},"updatedAt":{"description":"knowledge base node updated at","title":"Updatedat","type":"number"},"nodeType":{"description":"knowledge base node type","title":"Nodetype","type":"string"},"parentFolder":{"anyOf":[{"$ref":"#/components/schemas/Folder"},{"type":"null"}],"description":"knowledge base node parent folder"},"breadcrumbs":{"description":"knowledge base node breadcrumbs","items":{"$ref":"#/components/schemas/Folder"},"title":"Breadcrumbs","type":"array"},"agentPermission":{"$ref":"#/components/schemas/AgentPermissionResponse","description":"Agent permission"},"userPermission":{"$ref":"#/components/schemas/UserPermissionResponse","description":"User permission"},"sourceType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"knowledge base folder external source type","title":"Sourcetype"}},"required":["id","name","createdAt","updatedAt","nodeType","breadcrumbs","agentPermission","userPermission"],"title":"KnowledgeBaseNodeFolder","type":"object"},"CreatedByAgent":{"properties":{"id":{"description":"agent id","title":"Id","type":"string"},"email":{"description":"agent email","title":"Email","type":"string"},"firstName":{"description":"agent first name","title":"Firstname","type":"string"},"lastName":{"description":"agent last name","title":"Lastname","type":"string"}},"required":["id","email","firstName","lastName"],"title":"CreatedByAgent","type":"object"},"Folder":{"properties":{"id":{"description":"folder id","title":"Id","type":"string"},"name":{"description":"folder name","title":"Name","type":"string"}},"required":["id","name"],"title":"Folder","type":"object"},"AgentPermissionResponse":{"description":"Response model for agent permission.","properties":{"accessAgents":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessAgent"},"type":"array"},{"type":"null"}],"description":"Agents with access to the object.","title":"Accessagents"},"accessPermissionGroups":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessPermissionGroupResponse"},"type":"array"},{"type":"null"}],"description":"Permission groups with access to the object, with names.","title":"Accesspermissiongroups"},"viewAccessToAgent":{"description":"Whether agents may view the object.","title":"Viewaccesstoagent","type":"boolean"}},"required":["viewAccessToAgent"],"title":"AgentPermissionResponse","type":"object"},"AccessAgent":{"properties":{"agentId":{"description":"エージェントID","title":"Agentid","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"アクセス方法"}},"required":["agentId","accessType"],"title":"AccessAgent","type":"object"},"ObjectAccessType":{"enum":["order_1_editor","order_2_reader"],"title":"ObjectAccessType","type":"string"},"AccessPermissionGroupResponse":{"description":"Response model for access permission group with name included.","properties":{"permissionGroupId":{"description":"The permission group ID","title":"Permissiongroupid","type":"string"},"permissionGroupName":{"description":"The permission group name","title":"Permissiongroupname","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"The access type"}},"required":["permissionGroupId","permissionGroupName","accessType"],"title":"AccessPermissionGroupResponse","type":"object"},"UserPermissionResponse":{"properties":{"ownUserIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"Customer-managed user IDs allowed by the access filters.","title":"Ownuserids"},"customerGroups":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"Customer group values allowed by the access filters.","title":"Customergroups"},"viewAccessToUser":{"description":"Whether users may view the object.","title":"Viewaccesstouser","type":"boolean"}},"required":["viewAccessToUser"],"title":"UserPermissionResponse","type":"object"},"KnowledgeBaseNodeFile":{"properties":{"id":{"description":"knowledge base node id","title":"Id","type":"string"},"name":{"description":"knowledge base node name","title":"Name","type":"string"},"createdAt":{"description":"knowledge base node created at","title":"Createdat","type":"number"},"createdBy":{"anyOf":[{"$ref":"#/components/schemas/CreatedByAgent"},{"type":"null"}],"description":"agent who created this node"},"updatedAt":{"description":"knowledge base node updated at","title":"Updatedat","type":"number"},"nodeType":{"description":"knowledge base node type","title":"Nodetype","type":"string"},"parentFolder":{"anyOf":[{"$ref":"#/components/schemas/Folder"},{"type":"null"}],"description":"knowledge base node parent folder"},"breadcrumbs":{"description":"knowledge base node breadcrumbs","items":{"$ref":"#/components/schemas/Folder"},"title":"Breadcrumbs","type":"array"},"agentPermission":{"$ref":"#/components/schemas/AgentPermissionResponse","description":"Agent permission"},"userPermission":{"$ref":"#/components/schemas/UserPermissionResponse","description":"User permission"},"piiDetected":{"default":false,"description":"Whether the document has at least one PII masking entity. False also includes documents that have not been checked for PII.","title":"Piidetected","type":"boolean"},"hashtags":{"description":"knowledge base hashtags","items":{"type":"string"},"title":"Hashtags","type":"array"},"status":{"description":"knowledge base status","title":"Status","type":"string"},"size":{"description":"knowledge base size","title":"Size","type":"integer"},"processState":{"description":"knowledge base process state","title":"Processstate","type":"string"},"properties":{"anyOf":[{"items":{"$ref":"#/components/schemas/KnowledgeBaseFileProperty"},"type":"array"},{"type":"null"}],"description":"knowledge base properties","title":"Properties"},"action":{"anyOf":[{"$ref":"#/components/schemas/KnowledgeBaseUploadAction"},{"type":"null"}],"description":"Upload result for this document: 'created', 'overwritten', 'skipped', or 'suffix_added'. Only set on upload responses."},"sourceType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"knowledge base document source type","title":"Sourcetype"}},"required":["id","name","createdAt","updatedAt","nodeType","breadcrumbs","agentPermission","userPermission","hashtags","status","size","processState"],"title":"KnowledgeBaseNodeFile","type":"object"},"KnowledgeBaseFileProperty":{"properties":{"key":{"description":"property key","title":"Key","type":"string"},"value":{"description":"property value","title":"Value","type":"string"}},"required":["key","value"],"title":"KnowledgeBaseFileProperty","type":"object"},"KnowledgeBaseUploadAction":{"enum":["created","overwritten","skipped","suffix_added"],"title":"KnowledgeBaseUploadAction","type":"string"},"UploadKnowledgeBaseNodesResponse":{"description":"Upload outcome including the archive entries that produced no document.\n\nReturned instead of the plain node list when the request sets `includeZipExcludedEntries`.","properties":{"results":{"description":"Uploaded knowledge base nodes","items":{"$ref":"#/components/schemas/KnowledgeBaseNodeResponse"},"title":"Results","type":"array"},"zipExcludedEntries":{"description":"Files inside an uploaded archive that never became documents; empty for a non-archive upload. A document that already existed and was left as-is is reported through the node's `action` instead.","items":{"$ref":"#/components/schemas/ZipExcludedEntryResponse"},"title":"Zipexcludedentries","type":"array"}},"required":["results"],"title":"UploadKnowledgeBaseNodesResponse","type":"object"},"ZipExcludedEntryResponse":{"description":"A file inside an uploaded archive that never became a document.","properties":{"path":{"description":"Path of the file inside the archive, relative to the folder it expanded into.","title":"Path","type":"string"},"size":{"description":"Uncompressed size of the file in bytes.","title":"Size","type":"integer"},"reason":{"$ref":"#/components/schemas/ZipEntryExclusionReason","description":"Why the file was left out."}},"required":["path","size","reason"],"title":"ZipExcludedEntryResponse","type":"object"},"ZipEntryExclusionReason":{"description":"Why a file inside an uploaded archive never became a document.\n\nDistinct from ``KnowledgeBaseUploadAction.SKIPPED``, which means the document is already there\nand was left as-is.","enum":["file_size_limit_exceeded","unsupported_extension","invalid_file"],"title":"ZipEntryExclusionReason","type":"string"},"AccessPermissionGroup":{"properties":{"permissionGroupId":{"description":"アクセス許可グループのグループID","title":"Permissiongroupid","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"アクセス許可グループの権限種別"}},"required":["permissionGroupId","accessType"],"title":"AccessPermissionGroup","type":"object"},"AccessUserFilter":{"properties":{"variableName":{"$ref":"#/components/schemas/AccessUserFilterEnum","description":"フィルターの変数名"},"value":{"description":"フィルターの値","title":"Value","type":"string"}},"required":["variableName","value"],"title":"AccessUserFilter","type":"object"},"AccessUserFilterEnum":{"description":"システム変数以外の変数を追加する場合は、再設計が必要です。","enum":["CUSTOMER_ID","CUSTOMER_GROUP"],"title":"AccessUserFilterEnum","type":"string"},"KnowledgeBaseNotificationHookEnum":{"description":"Notification hooks that can be triggered on document ingestion events.","enum":["email_on_ingestion_complete"],"title":"KnowledgeBaseNotificationHookEnum","type":"string"}}},"paths":{"/webapi/v2/knowledge_base_nodes/upload":{"post":{"operationId":"django_server_knowledge_base_views_rest_knowledge_base_node_api_upload_knowledge_base_node","summary":"ドキュメントをアップロードする","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}],"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"anyOf":[{"items":{"$ref":"#/components/schemas/KnowledgeBaseNodeResponse"},"type":"array"},{"$ref":"#/components/schemas/UploadKnowledgeBaseNodesResponse"}],"title":"Response"}}}},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication failed. The API-KEY header is missing or invalid."},"403":{"description":"Access denied. The project is inactive or the request IP is not allowed."},"500":{"description":"Internal server error."}},"description":"ドキュメントメニュー内にドキュメントをアップロードします。","tags":["KnowledgeBase"],"requestBody":{"content":{"multipart/form-data":{"schema":{"title":"MultiPartBodyParams","type":"object","properties":{"fileName":{"description":"ドキュメントのファイル名","title":"Filename","type":"string"},"hashtags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"ドキュメントのハッシュタグ","title":"Hashtags"},"targetFolderId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ドキュメントのターゲットフォルダーID","title":"Targetfolderid"},"isOverwriteFolderAccess":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"ドキュメントの上書きフォルダアクセスフラグ","title":"Isoverwritefolderaccess"},"isOverwrite":{"default":false,"description":"If 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. For a ZIP, this updates the folder named after the archive instead of creating another one: unchanged entries are skipped, a changed entry replaces the existing document, and the rest are created. Entries missing from the ZIP are kept. Requires the KB_ZIP_UPSERT_UPLOAD add-on; without it a ZIP always gets its own folder.","title":"Isoverwrite","type":"boolean"},"accessPermissionGroups":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessPermissionGroup"},"type":"array"},{"type":"null"}],"description":"ドキュメントのアクセス許可グループ","title":"Accesspermissiongroups"},"accessAgents":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessAgent"},"type":"array"},{"type":"null"}],"description":"ドキュメントのアクセスエージェント","title":"Accessagents"},"accessUserFilters":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessUserFilter"},"type":"array"},{"type":"null"}],"description":"ドキュメントのアクセスユーザーフィルター","title":"Accessuserfilters"},"viewAccessToAgent":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"ドキュメントのエージェントフラグへの閲覧アクセス","title":"Viewaccesstoagent"},"viewAccessToUser":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"ドキュメントのユーザーフラグへの表示アクセス","title":"Viewaccesstouser"},"useLayout":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":true,"description":"ドキュメントの解析処理を向上させるためにレイアウト処理を使用するかどうかを指定します。プロジェクトでこの機能が許可されている場合にのみ使用されます。 機能の有効化が必要な場合は担当のカスタマーサクセスまでお問い合わせください。","title":"Uselayout"},"useImageDescription":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":true,"description":"ドキュメントの解析処理を向上させるためにimage description処理を使用するかどうかを指定します。プロジェクトでこの機能が許可されている場合にのみ使用されます。 機能の有効化が必要な場合は担当のカスタマーサクセスまでお問い合わせください。","title":"Useimagedescription"},"useOcr":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"Whether to use OCR for document processing","title":"Useocr"},"properties":{"type":"array","items":{"properties":{"key":{"title":"Key","type":"string"},"value":{"title":"Value","type":"string"}},"required":["key","value"],"title":"KnowledgeBaseFileProperty","type":"object"},"description":"ナレッジベースのプロパティ。","title":"Properties"},"notificationHooks":{"anyOf":[{"items":{"$ref":"#/components/schemas/KnowledgeBaseNotificationHookEnum"},"type":"array"},{"type":"null"}],"description":"List of notification hooks to trigger on document ingestion events","title":"Notificationhooks"},"includeZipExcludedEntries":{"default":false,"description":"If true, the response becomes an object with the uploaded documents under `results` and the ZIP entries that never became documents under `zipExcludedEntries`. Left false, the response stays the plain list of uploaded documents and those entries are not reported.","title":"Includezipexcludedentries","type":"boolean"},"file":{"format":"binary","title":"File","type":"string"}},"required":["fileName","file"]}}},"required":true}}}}}
```

## Replace Document File

> This API allows you to replace the file of an existing document while keeping its metadata (hashtags, permissions, etc.).\
> \
> \## Headers\
> \
> \- API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.\
> \- AGENT-EMAIL (string, optional): The email address of the agent performing the API call.\
> \- USER-EMAIL (string, optional): The email address to associate with the user.\
> \- OWN-USER-ID (string, optional): The user ID to identify or create a user.\
> \
> \## Path Parameters\
> \
> \- nodeId (string, required): The global ID of the document to replace.\
> \
> \## Request Body (multipart/form-data)\
> \
> \- file (binary, required): The new file to upload.\
> \- resetClueFeedbacks (boolean, optional): Whether to reset answer feedbacks for this document. Defaults to \*\*false\*\*.

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"KnowledgeBase","description":"User related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}},"schemas":{"KnowledgeBaseNodeResponse":{"properties":{"result":{"anyOf":[{"$ref":"#/components/schemas/KnowledgeBaseNodeFolder"},{"$ref":"#/components/schemas/KnowledgeBaseNodeFile"}],"description":"Knowledge base node","title":"Result"}},"required":["result"],"title":"KnowledgeBaseNodeResponse","type":"object"},"KnowledgeBaseNodeFolder":{"properties":{"id":{"description":"knowledge base node id","title":"Id","type":"string"},"name":{"description":"knowledge base node name","title":"Name","type":"string"},"createdAt":{"description":"knowledge base node created at","title":"Createdat","type":"number"},"createdBy":{"anyOf":[{"$ref":"#/components/schemas/CreatedByAgent"},{"type":"null"}],"description":"agent who created this node"},"updatedAt":{"description":"knowledge base node updated at","title":"Updatedat","type":"number"},"nodeType":{"description":"knowledge base node type","title":"Nodetype","type":"string"},"parentFolder":{"anyOf":[{"$ref":"#/components/schemas/Folder"},{"type":"null"}],"description":"knowledge base node parent folder"},"breadcrumbs":{"description":"knowledge base node breadcrumbs","items":{"$ref":"#/components/schemas/Folder"},"title":"Breadcrumbs","type":"array"},"agentPermission":{"$ref":"#/components/schemas/AgentPermissionResponse","description":"Agent permission"},"userPermission":{"$ref":"#/components/schemas/UserPermissionResponse","description":"User permission"},"sourceType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"knowledge base folder external source type","title":"Sourcetype"}},"required":["id","name","createdAt","updatedAt","nodeType","breadcrumbs","agentPermission","userPermission"],"title":"KnowledgeBaseNodeFolder","type":"object"},"CreatedByAgent":{"properties":{"id":{"description":"agent id","title":"Id","type":"string"},"email":{"description":"agent email","title":"Email","type":"string"},"firstName":{"description":"agent first name","title":"Firstname","type":"string"},"lastName":{"description":"agent last name","title":"Lastname","type":"string"}},"required":["id","email","firstName","lastName"],"title":"CreatedByAgent","type":"object"},"Folder":{"properties":{"id":{"description":"folder id","title":"Id","type":"string"},"name":{"description":"folder name","title":"Name","type":"string"}},"required":["id","name"],"title":"Folder","type":"object"},"AgentPermissionResponse":{"description":"Response model for agent permission.","properties":{"accessAgents":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessAgent"},"type":"array"},{"type":"null"}],"description":"Agents with access to the object.","title":"Accessagents"},"accessPermissionGroups":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessPermissionGroupResponse"},"type":"array"},{"type":"null"}],"description":"Permission groups with access to the object, with names.","title":"Accesspermissiongroups"},"viewAccessToAgent":{"description":"Whether agents may view the object.","title":"Viewaccesstoagent","type":"boolean"}},"required":["viewAccessToAgent"],"title":"AgentPermissionResponse","type":"object"},"AccessAgent":{"properties":{"agentId":{"description":"エージェントID","title":"Agentid","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"アクセス方法"}},"required":["agentId","accessType"],"title":"AccessAgent","type":"object"},"ObjectAccessType":{"enum":["order_1_editor","order_2_reader"],"title":"ObjectAccessType","type":"string"},"AccessPermissionGroupResponse":{"description":"Response model for access permission group with name included.","properties":{"permissionGroupId":{"description":"The permission group ID","title":"Permissiongroupid","type":"string"},"permissionGroupName":{"description":"The permission group name","title":"Permissiongroupname","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"The access type"}},"required":["permissionGroupId","permissionGroupName","accessType"],"title":"AccessPermissionGroupResponse","type":"object"},"UserPermissionResponse":{"properties":{"ownUserIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"Customer-managed user IDs allowed by the access filters.","title":"Ownuserids"},"customerGroups":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"Customer group values allowed by the access filters.","title":"Customergroups"},"viewAccessToUser":{"description":"Whether users may view the object.","title":"Viewaccesstouser","type":"boolean"}},"required":["viewAccessToUser"],"title":"UserPermissionResponse","type":"object"},"KnowledgeBaseNodeFile":{"properties":{"id":{"description":"knowledge base node id","title":"Id","type":"string"},"name":{"description":"knowledge base node name","title":"Name","type":"string"},"createdAt":{"description":"knowledge base node created at","title":"Createdat","type":"number"},"createdBy":{"anyOf":[{"$ref":"#/components/schemas/CreatedByAgent"},{"type":"null"}],"description":"agent who created this node"},"updatedAt":{"description":"knowledge base node updated at","title":"Updatedat","type":"number"},"nodeType":{"description":"knowledge base node type","title":"Nodetype","type":"string"},"parentFolder":{"anyOf":[{"$ref":"#/components/schemas/Folder"},{"type":"null"}],"description":"knowledge base node parent folder"},"breadcrumbs":{"description":"knowledge base node breadcrumbs","items":{"$ref":"#/components/schemas/Folder"},"title":"Breadcrumbs","type":"array"},"agentPermission":{"$ref":"#/components/schemas/AgentPermissionResponse","description":"Agent permission"},"userPermission":{"$ref":"#/components/schemas/UserPermissionResponse","description":"User permission"},"piiDetected":{"default":false,"description":"Whether the document has at least one PII masking entity. False also includes documents that have not been checked for PII.","title":"Piidetected","type":"boolean"},"hashtags":{"description":"knowledge base hashtags","items":{"type":"string"},"title":"Hashtags","type":"array"},"status":{"description":"knowledge base status","title":"Status","type":"string"},"size":{"description":"knowledge base size","title":"Size","type":"integer"},"processState":{"description":"knowledge base process state","title":"Processstate","type":"string"},"properties":{"anyOf":[{"items":{"$ref":"#/components/schemas/KnowledgeBaseFileProperty"},"type":"array"},{"type":"null"}],"description":"knowledge base properties","title":"Properties"},"action":{"anyOf":[{"$ref":"#/components/schemas/KnowledgeBaseUploadAction"},{"type":"null"}],"description":"Upload result for this document: 'created', 'overwritten', 'skipped', or 'suffix_added'. Only set on upload responses."},"sourceType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"knowledge base document source type","title":"Sourcetype"}},"required":["id","name","createdAt","updatedAt","nodeType","breadcrumbs","agentPermission","userPermission","hashtags","status","size","processState"],"title":"KnowledgeBaseNodeFile","type":"object"},"KnowledgeBaseFileProperty":{"properties":{"key":{"description":"property key","title":"Key","type":"string"},"value":{"description":"property value","title":"Value","type":"string"}},"required":["key","value"],"title":"KnowledgeBaseFileProperty","type":"object"},"KnowledgeBaseUploadAction":{"enum":["created","overwritten","skipped","suffix_added"],"title":"KnowledgeBaseUploadAction","type":"string"}}},"paths":{"/webapi/v2/knowledge_base_nodes/{node_id}/replace":{"post":{"operationId":"django_server_knowledge_base_views_rest_knowledge_base_node_api_replace_knowledge_base_node","summary":"Replace Document File","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"},{"in":"path","name":"node_id","schema":{"title":"Node Id","type":"string"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeBaseNodeResponse"}}}},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication failed. The API-KEY header is missing or invalid."},"403":{"description":"Access denied. The project is inactive or the request IP is not allowed."},"500":{"description":"Internal server error."}},"description":"This API allows you to replace the file of an existing document while keeping its metadata (hashtags, permissions, etc.).\n\n## Headers\n\n- API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.\n- AGENT-EMAIL (string, optional): The email address of the agent performing the API call.\n- USER-EMAIL (string, optional): The email address to associate with the user.\n- OWN-USER-ID (string, optional): The user ID to identify or create a user.\n\n## Path Parameters\n\n- nodeId (string, required): The global ID of the document to replace.\n\n## Request Body (multipart/form-data)\n\n- file (binary, required): The new file to upload.\n- resetClueFeedbacks (boolean, optional): Whether to reset answer feedbacks for this document. Defaults to **false**.","tags":["KnowledgeBase"],"requestBody":{"content":{"multipart/form-data":{"schema":{"title":"MultiPartBodyParams","type":"object","properties":{"resetClueFeedbacks":{"default":false,"description":"Whether to reset answer feedbacks for this document.","title":"Resetcluefeedbacks","type":"boolean"},"file":{"format":"binary","title":"File","type":"string"}},"required":["file"]}}},"required":true}}}}}
```

## AWS S3からのアップロード

> S3からドキュメントをアップロードします。このAPIを使用すると、S3に保存されているドキュメントをAlliのドキュメントメニューに転送することができます。\
> 利用可能なファイル形式は、「ドキュメントのアップロード」セクションと同じです。

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"KnowledgeBase","description":"User related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}},"schemas":{"KnowledgeBaseNodeResponse":{"properties":{"result":{"anyOf":[{"$ref":"#/components/schemas/KnowledgeBaseNodeFolder"},{"$ref":"#/components/schemas/KnowledgeBaseNodeFile"}],"description":"Knowledge base node","title":"Result"}},"required":["result"],"title":"KnowledgeBaseNodeResponse","type":"object"},"KnowledgeBaseNodeFolder":{"properties":{"id":{"description":"knowledge base node id","title":"Id","type":"string"},"name":{"description":"knowledge base node name","title":"Name","type":"string"},"createdAt":{"description":"knowledge base node created at","title":"Createdat","type":"number"},"createdBy":{"anyOf":[{"$ref":"#/components/schemas/CreatedByAgent"},{"type":"null"}],"description":"agent who created this node"},"updatedAt":{"description":"knowledge base node updated at","title":"Updatedat","type":"number"},"nodeType":{"description":"knowledge base node type","title":"Nodetype","type":"string"},"parentFolder":{"anyOf":[{"$ref":"#/components/schemas/Folder"},{"type":"null"}],"description":"knowledge base node parent folder"},"breadcrumbs":{"description":"knowledge base node breadcrumbs","items":{"$ref":"#/components/schemas/Folder"},"title":"Breadcrumbs","type":"array"},"agentPermission":{"$ref":"#/components/schemas/AgentPermissionResponse","description":"Agent permission"},"userPermission":{"$ref":"#/components/schemas/UserPermissionResponse","description":"User permission"},"sourceType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"knowledge base folder external source type","title":"Sourcetype"}},"required":["id","name","createdAt","updatedAt","nodeType","breadcrumbs","agentPermission","userPermission"],"title":"KnowledgeBaseNodeFolder","type":"object"},"CreatedByAgent":{"properties":{"id":{"description":"agent id","title":"Id","type":"string"},"email":{"description":"agent email","title":"Email","type":"string"},"firstName":{"description":"agent first name","title":"Firstname","type":"string"},"lastName":{"description":"agent last name","title":"Lastname","type":"string"}},"required":["id","email","firstName","lastName"],"title":"CreatedByAgent","type":"object"},"Folder":{"properties":{"id":{"description":"folder id","title":"Id","type":"string"},"name":{"description":"folder name","title":"Name","type":"string"}},"required":["id","name"],"title":"Folder","type":"object"},"AgentPermissionResponse":{"description":"Response model for agent permission.","properties":{"accessAgents":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessAgent"},"type":"array"},{"type":"null"}],"description":"Agents with access to the object.","title":"Accessagents"},"accessPermissionGroups":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessPermissionGroupResponse"},"type":"array"},{"type":"null"}],"description":"Permission groups with access to the object, with names.","title":"Accesspermissiongroups"},"viewAccessToAgent":{"description":"Whether agents may view the object.","title":"Viewaccesstoagent","type":"boolean"}},"required":["viewAccessToAgent"],"title":"AgentPermissionResponse","type":"object"},"AccessAgent":{"properties":{"agentId":{"description":"エージェントID","title":"Agentid","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"アクセス方法"}},"required":["agentId","accessType"],"title":"AccessAgent","type":"object"},"ObjectAccessType":{"enum":["order_1_editor","order_2_reader"],"title":"ObjectAccessType","type":"string"},"AccessPermissionGroupResponse":{"description":"Response model for access permission group with name included.","properties":{"permissionGroupId":{"description":"The permission group ID","title":"Permissiongroupid","type":"string"},"permissionGroupName":{"description":"The permission group name","title":"Permissiongroupname","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"The access type"}},"required":["permissionGroupId","permissionGroupName","accessType"],"title":"AccessPermissionGroupResponse","type":"object"},"UserPermissionResponse":{"properties":{"ownUserIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"Customer-managed user IDs allowed by the access filters.","title":"Ownuserids"},"customerGroups":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"Customer group values allowed by the access filters.","title":"Customergroups"},"viewAccessToUser":{"description":"Whether users may view the object.","title":"Viewaccesstouser","type":"boolean"}},"required":["viewAccessToUser"],"title":"UserPermissionResponse","type":"object"},"KnowledgeBaseNodeFile":{"properties":{"id":{"description":"knowledge base node id","title":"Id","type":"string"},"name":{"description":"knowledge base node name","title":"Name","type":"string"},"createdAt":{"description":"knowledge base node created at","title":"Createdat","type":"number"},"createdBy":{"anyOf":[{"$ref":"#/components/schemas/CreatedByAgent"},{"type":"null"}],"description":"agent who created this node"},"updatedAt":{"description":"knowledge base node updated at","title":"Updatedat","type":"number"},"nodeType":{"description":"knowledge base node type","title":"Nodetype","type":"string"},"parentFolder":{"anyOf":[{"$ref":"#/components/schemas/Folder"},{"type":"null"}],"description":"knowledge base node parent folder"},"breadcrumbs":{"description":"knowledge base node breadcrumbs","items":{"$ref":"#/components/schemas/Folder"},"title":"Breadcrumbs","type":"array"},"agentPermission":{"$ref":"#/components/schemas/AgentPermissionResponse","description":"Agent permission"},"userPermission":{"$ref":"#/components/schemas/UserPermissionResponse","description":"User permission"},"piiDetected":{"default":false,"description":"Whether the document has at least one PII masking entity. False also includes documents that have not been checked for PII.","title":"Piidetected","type":"boolean"},"hashtags":{"description":"knowledge base hashtags","items":{"type":"string"},"title":"Hashtags","type":"array"},"status":{"description":"knowledge base status","title":"Status","type":"string"},"size":{"description":"knowledge base size","title":"Size","type":"integer"},"processState":{"description":"knowledge base process state","title":"Processstate","type":"string"},"properties":{"anyOf":[{"items":{"$ref":"#/components/schemas/KnowledgeBaseFileProperty"},"type":"array"},{"type":"null"}],"description":"knowledge base properties","title":"Properties"},"action":{"anyOf":[{"$ref":"#/components/schemas/KnowledgeBaseUploadAction"},{"type":"null"}],"description":"Upload result for this document: 'created', 'overwritten', 'skipped', or 'suffix_added'. Only set on upload responses."},"sourceType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"knowledge base document source type","title":"Sourcetype"}},"required":["id","name","createdAt","updatedAt","nodeType","breadcrumbs","agentPermission","userPermission","hashtags","status","size","processState"],"title":"KnowledgeBaseNodeFile","type":"object"},"KnowledgeBaseFileProperty":{"properties":{"key":{"description":"property key","title":"Key","type":"string"},"value":{"description":"property value","title":"Value","type":"string"}},"required":["key","value"],"title":"KnowledgeBaseFileProperty","type":"object"},"KnowledgeBaseUploadAction":{"enum":["created","overwritten","skipped","suffix_added"],"title":"KnowledgeBaseUploadAction","type":"string"},"UploadFromAWSS3Request":{"description":"S3からファイルをアップロードするためのリクエストモデル。","properties":{"fileName":{"description":"ファイル名","title":"Filename","type":"string"},"hashtags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"ハッシュタグ","title":"Hashtags"},"targetFolderId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ターゲットフォルダーID","title":"Targetfolderid"},"isOverwriteFolderAccess":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"フォルダーのアクセス権限上書きフラグ","title":"Isoverwritefolderaccess"},"isOverwrite":{"default":false,"description":"If 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. For a ZIP, this updates the folder named after the archive instead of creating another one: unchanged entries are skipped, a changed entry replaces the existing document, and the rest are created. Entries missing from the ZIP are kept. Requires the KB_ZIP_UPSERT_UPLOAD add-on; without it a ZIP always gets its own folder.","title":"Isoverwrite","type":"boolean"},"accessPermissionGroups":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessPermissionGroup"},"type":"array"},{"type":"null"}],"description":"アクセス許可グループ","title":"Accesspermissiongroups"},"accessAgents":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessAgent"},"type":"array"},{"type":"null"}],"description":"アクセス管理者","title":"Accessagents"},"accessUserFilters":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessUserFilter"},"type":"array"},{"type":"null"}],"description":"アクセスユーザーフィルター","title":"Accessuserfilters"},"viewAccessToAgent":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"管理者閲覧権限フラグ","title":"Viewaccesstoagent"},"viewAccessToUser":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"ユーザーの閲覧権限フラグ","title":"Viewaccesstouser"},"useLayout":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":true,"description":"ドキュメントの解析処理を向上させるためにレイアウト処理を使用するかどうかを指定します。プロジェクトでこの機能が許可されている場合にのみ使用されます。 機能の有効化が必要な場合は担当のカスタマーサクセスまでお問い合わせください。","title":"Uselayout"},"useImageDescription":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":true,"description":"ドキュメントの解析処理を向上させるためにimage description処理を使用するかどうかを指定します。プロジェクトでこの機能が許可されている場合にのみ使用されます。 機能の有効化が必要な場合は担当のカスタマーサクセスまでお問い合わせください。","title":"Useimagedescription"},"useOcr":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"Whether to use OCR for document processing","title":"Useocr"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/KnowledgeBaseFileProperty"},"description":"ナレッジベースノードに付与するメタ情報","title":"Properties"},"notificationHooks":{"anyOf":[{"items":{"$ref":"#/components/schemas/KnowledgeBaseNotificationHookEnum"},"type":"array"},{"type":"null"}],"description":"List of notification hooks to trigger on document ingestion events","title":"Notificationhooks"},"bucketObjectPath":{"description":"ファイルのバケットオブジェクトパス","title":"Bucketobjectpath","type":"string"},"awsSecretKey":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"S3シークレットキー。","title":"Awssecretkey"},"awsAccessKey":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"S3アクセスキー。","title":"Awsaccesskey"},"awsIamRoleArn":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"AWS IAM Role ARN","title":"Awsiamrolearn"},"awsExternalId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"AWS IAMロールの外部ID","title":"Awsexternalid"}},"required":["fileName","bucketObjectPath"],"title":"UploadFromAWSS3Request","type":"object"},"AccessPermissionGroup":{"properties":{"permissionGroupId":{"description":"アクセス許可グループのグループID","title":"Permissiongroupid","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"アクセス許可グループの権限種別"}},"required":["permissionGroupId","accessType"],"title":"AccessPermissionGroup","type":"object"},"AccessUserFilter":{"properties":{"variableName":{"$ref":"#/components/schemas/AccessUserFilterEnum","description":"フィルターの変数名"},"value":{"description":"フィルターの値","title":"Value","type":"string"}},"required":["variableName","value"],"title":"AccessUserFilter","type":"object"},"AccessUserFilterEnum":{"description":"システム変数以外の変数を追加する場合は、再設計が必要です。","enum":["CUSTOMER_ID","CUSTOMER_GROUP"],"title":"AccessUserFilterEnum","type":"string"},"KnowledgeBaseNotificationHookEnum":{"description":"Notification hooks that can be triggered on document ingestion events.","enum":["email_on_ingestion_complete"],"title":"KnowledgeBaseNotificationHookEnum","type":"string"}}},"paths":{"/webapi/v2/knowledge_base_nodes/upload_from_aws_s3":{"post":{"operationId":"django_server_knowledge_base_views_rest_knowledge_base_node_api_upload_from_aws_s3","summary":"AWS S3からのアップロード","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}],"responses":{"200":{"description":"正常に完了しました。","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeBaseNodeResponse"}}}},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication failed. The API-KEY header is missing or invalid."},"403":{"description":"Access denied. The project is inactive or the request IP is not allowed."},"500":{"description":"Internal server error."}},"description":"S3からドキュメントをアップロードします。このAPIを使用すると、S3に保存されているドキュメントをAlliのドキュメントメニューに転送することができます。\n利用可能なファイル形式は、「ドキュメントのアップロード」セクションと同じです。","tags":["KnowledgeBase"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadFromAWSS3Request"}}},"required":true}}}}}
```

## Azure Blob からアップロード

> Azure Blob Storageからドキュメントをアップロード\
> \
> このAPIを使用すると、Azure Blob Storageに保存されているドキュメントをCognitive Searchに転送することができます。\
> \
> これらはダッシュボード上にナレッジベースのドキュメントとして表示されます。\
> \
> 使用可能なファイル形式は、「ドキュメントのアップロード」セクションと同じです。

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"KnowledgeBase","description":"User related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}},"schemas":{"KnowledgeBaseNodeResponse":{"properties":{"result":{"anyOf":[{"$ref":"#/components/schemas/KnowledgeBaseNodeFolder"},{"$ref":"#/components/schemas/KnowledgeBaseNodeFile"}],"description":"Knowledge base node","title":"Result"}},"required":["result"],"title":"KnowledgeBaseNodeResponse","type":"object"},"KnowledgeBaseNodeFolder":{"properties":{"id":{"description":"knowledge base node id","title":"Id","type":"string"},"name":{"description":"knowledge base node name","title":"Name","type":"string"},"createdAt":{"description":"knowledge base node created at","title":"Createdat","type":"number"},"createdBy":{"anyOf":[{"$ref":"#/components/schemas/CreatedByAgent"},{"type":"null"}],"description":"agent who created this node"},"updatedAt":{"description":"knowledge base node updated at","title":"Updatedat","type":"number"},"nodeType":{"description":"knowledge base node type","title":"Nodetype","type":"string"},"parentFolder":{"anyOf":[{"$ref":"#/components/schemas/Folder"},{"type":"null"}],"description":"knowledge base node parent folder"},"breadcrumbs":{"description":"knowledge base node breadcrumbs","items":{"$ref":"#/components/schemas/Folder"},"title":"Breadcrumbs","type":"array"},"agentPermission":{"$ref":"#/components/schemas/AgentPermissionResponse","description":"Agent permission"},"userPermission":{"$ref":"#/components/schemas/UserPermissionResponse","description":"User permission"},"sourceType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"knowledge base folder external source type","title":"Sourcetype"}},"required":["id","name","createdAt","updatedAt","nodeType","breadcrumbs","agentPermission","userPermission"],"title":"KnowledgeBaseNodeFolder","type":"object"},"CreatedByAgent":{"properties":{"id":{"description":"agent id","title":"Id","type":"string"},"email":{"description":"agent email","title":"Email","type":"string"},"firstName":{"description":"agent first name","title":"Firstname","type":"string"},"lastName":{"description":"agent last name","title":"Lastname","type":"string"}},"required":["id","email","firstName","lastName"],"title":"CreatedByAgent","type":"object"},"Folder":{"properties":{"id":{"description":"folder id","title":"Id","type":"string"},"name":{"description":"folder name","title":"Name","type":"string"}},"required":["id","name"],"title":"Folder","type":"object"},"AgentPermissionResponse":{"description":"Response model for agent permission.","properties":{"accessAgents":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessAgent"},"type":"array"},{"type":"null"}],"description":"Agents with access to the object.","title":"Accessagents"},"accessPermissionGroups":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessPermissionGroupResponse"},"type":"array"},{"type":"null"}],"description":"Permission groups with access to the object, with names.","title":"Accesspermissiongroups"},"viewAccessToAgent":{"description":"Whether agents may view the object.","title":"Viewaccesstoagent","type":"boolean"}},"required":["viewAccessToAgent"],"title":"AgentPermissionResponse","type":"object"},"AccessAgent":{"properties":{"agentId":{"description":"エージェントID","title":"Agentid","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"アクセス方法"}},"required":["agentId","accessType"],"title":"AccessAgent","type":"object"},"ObjectAccessType":{"enum":["order_1_editor","order_2_reader"],"title":"ObjectAccessType","type":"string"},"AccessPermissionGroupResponse":{"description":"Response model for access permission group with name included.","properties":{"permissionGroupId":{"description":"The permission group ID","title":"Permissiongroupid","type":"string"},"permissionGroupName":{"description":"The permission group name","title":"Permissiongroupname","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"The access type"}},"required":["permissionGroupId","permissionGroupName","accessType"],"title":"AccessPermissionGroupResponse","type":"object"},"UserPermissionResponse":{"properties":{"ownUserIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"Customer-managed user IDs allowed by the access filters.","title":"Ownuserids"},"customerGroups":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"Customer group values allowed by the access filters.","title":"Customergroups"},"viewAccessToUser":{"description":"Whether users may view the object.","title":"Viewaccesstouser","type":"boolean"}},"required":["viewAccessToUser"],"title":"UserPermissionResponse","type":"object"},"KnowledgeBaseNodeFile":{"properties":{"id":{"description":"knowledge base node id","title":"Id","type":"string"},"name":{"description":"knowledge base node name","title":"Name","type":"string"},"createdAt":{"description":"knowledge base node created at","title":"Createdat","type":"number"},"createdBy":{"anyOf":[{"$ref":"#/components/schemas/CreatedByAgent"},{"type":"null"}],"description":"agent who created this node"},"updatedAt":{"description":"knowledge base node updated at","title":"Updatedat","type":"number"},"nodeType":{"description":"knowledge base node type","title":"Nodetype","type":"string"},"parentFolder":{"anyOf":[{"$ref":"#/components/schemas/Folder"},{"type":"null"}],"description":"knowledge base node parent folder"},"breadcrumbs":{"description":"knowledge base node breadcrumbs","items":{"$ref":"#/components/schemas/Folder"},"title":"Breadcrumbs","type":"array"},"agentPermission":{"$ref":"#/components/schemas/AgentPermissionResponse","description":"Agent permission"},"userPermission":{"$ref":"#/components/schemas/UserPermissionResponse","description":"User permission"},"piiDetected":{"default":false,"description":"Whether the document has at least one PII masking entity. False also includes documents that have not been checked for PII.","title":"Piidetected","type":"boolean"},"hashtags":{"description":"knowledge base hashtags","items":{"type":"string"},"title":"Hashtags","type":"array"},"status":{"description":"knowledge base status","title":"Status","type":"string"},"size":{"description":"knowledge base size","title":"Size","type":"integer"},"processState":{"description":"knowledge base process state","title":"Processstate","type":"string"},"properties":{"anyOf":[{"items":{"$ref":"#/components/schemas/KnowledgeBaseFileProperty"},"type":"array"},{"type":"null"}],"description":"knowledge base properties","title":"Properties"},"action":{"anyOf":[{"$ref":"#/components/schemas/KnowledgeBaseUploadAction"},{"type":"null"}],"description":"Upload result for this document: 'created', 'overwritten', 'skipped', or 'suffix_added'. Only set on upload responses."},"sourceType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"knowledge base document source type","title":"Sourcetype"}},"required":["id","name","createdAt","updatedAt","nodeType","breadcrumbs","agentPermission","userPermission","hashtags","status","size","processState"],"title":"KnowledgeBaseNodeFile","type":"object"},"KnowledgeBaseFileProperty":{"properties":{"key":{"description":"property key","title":"Key","type":"string"},"value":{"description":"property value","title":"Value","type":"string"}},"required":["key","value"],"title":"KnowledgeBaseFileProperty","type":"object"},"KnowledgeBaseUploadAction":{"enum":["created","overwritten","skipped","suffix_added"],"title":"KnowledgeBaseUploadAction","type":"string"},"UploadFromAzureBlobRequest":{"description":"Azure Blob Storageからファイルをアップロードするためのリクエストモデル。","properties":{"fileName":{"description":"ファイル名","title":"Filename","type":"string"},"hashtags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"ハッシュタグ","title":"Hashtags"},"targetFolderId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ターゲットフォルダーID","title":"Targetfolderid"},"isOverwriteFolderAccess":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"フォルダのアクセス権限の上書きフラグ","title":"Isoverwritefolderaccess"},"isOverwrite":{"default":false,"description":"If 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. For a ZIP, this updates the folder named after the archive instead of creating another one: unchanged entries are skipped, a changed entry replaces the existing document, and the rest are created. Entries missing from the ZIP are kept. Requires the KB_ZIP_UPSERT_UPLOAD add-on; without it a ZIP always gets its own folder.","title":"Isoverwrite","type":"boolean"},"accessPermissionGroups":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessPermissionGroup"},"type":"array"},{"type":"null"}],"description":"アクセス許可グループ","title":"Accesspermissiongroups"},"accessAgents":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessAgent"},"type":"array"},{"type":"null"}],"description":"アクセス許可管理者","title":"Accessagents"},"accessUserFilters":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessUserFilter"},"type":"array"},{"type":"null"}],"description":"アクセスユーザーフィルター","title":"Accessuserfilters"},"viewAccessToAgent":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"管理者の閲覧権限","title":"Viewaccesstoagent"},"viewAccessToUser":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"ユーザーの閲覧権限","title":"Viewaccesstouser"},"useLayout":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":true,"description":"ドキュメントの解析処理を向上させるためにレイアウト処理を使用するかどうかを指定します。プロジェクトでこの機能が許可されている場合にのみ使用されます。 機能の有効化が必要な場合は担当のカスタマーサクセスまでお問い合わせください。","title":"Uselayout"},"useImageDescription":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":true,"description":"ドキュメントの解析処理を向上させるためにimage description処理を使用するかどうかを指定します。プロジェクトでこの機能が許可されている場合にのみ使用されます。 機能の有効化が必要な場合は担当のカスタマーサクセスまでお問い合わせください。","title":"Useimagedescription"},"useOcr":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"Whether to use OCR for document processing","title":"Useocr"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/KnowledgeBaseFileProperty"},"description":"ナレッジベースノードに付与するメタ情報","title":"Properties"},"notificationHooks":{"anyOf":[{"items":{"$ref":"#/components/schemas/KnowledgeBaseNotificationHookEnum"},"type":"array"},{"type":"null"}],"description":"List of notification hooks to trigger on document ingestion events","title":"Notificationhooks"},"containerBlobPath":{"description":"ファイルのコンテナブロブパス","title":"Containerblobpath","type":"string"},"azureConnectionString":{"description":"Azure Blob Storageの接続文字列。","title":"Azureconnectionstring","type":"string"}},"required":["fileName","containerBlobPath"],"title":"UploadFromAzureBlobRequest","type":"object"},"AccessPermissionGroup":{"properties":{"permissionGroupId":{"description":"アクセス許可グループのグループID","title":"Permissiongroupid","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"アクセス許可グループの権限種別"}},"required":["permissionGroupId","accessType"],"title":"AccessPermissionGroup","type":"object"},"AccessUserFilter":{"properties":{"variableName":{"$ref":"#/components/schemas/AccessUserFilterEnum","description":"フィルターの変数名"},"value":{"description":"フィルターの値","title":"Value","type":"string"}},"required":["variableName","value"],"title":"AccessUserFilter","type":"object"},"AccessUserFilterEnum":{"description":"システム変数以外の変数を追加する場合は、再設計が必要です。","enum":["CUSTOMER_ID","CUSTOMER_GROUP"],"title":"AccessUserFilterEnum","type":"string"},"KnowledgeBaseNotificationHookEnum":{"description":"Notification hooks that can be triggered on document ingestion events.","enum":["email_on_ingestion_complete"],"title":"KnowledgeBaseNotificationHookEnum","type":"string"}}},"paths":{"/webapi/v2/knowledge_base_nodes/upload_from_azure_blob":{"post":{"operationId":"django_server_knowledge_base_views_rest_knowledge_base_node_api_upload_from_azure_blob","summary":"Azure Blob からアップロード","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}],"responses":{"200":{"description":"了解しました。","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeBaseNodeResponse"}}}},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication failed. The API-KEY header is missing or invalid."},"403":{"description":"Access denied. The project is inactive or the request IP is not allowed."},"500":{"description":"Internal server error."}},"description":"Azure Blob Storageからドキュメントをアップロード\n\nこのAPIを使用すると、Azure Blob Storageに保存されているドキュメントをCognitive Searchに転送することができます。\n\nこれらはダッシュボード上にナレッジベースのドキュメントとして表示されます。\n\n使用可能なファイル形式は、「ドキュメントのアップロード」セクションと同じです。","tags":["KnowledgeBase"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadFromAzureBlobRequest"}}},"required":true}}}}}
```

## ドキュメントの検索

> ドキュメントメニュー内のドキュメントを検索します。

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"KnowledgeBase","description":"User related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}},"schemas":{"KnowledgeBaseNodesResponse":{"properties":{"result":{"$ref":"#/components/schemas/KnowledgeBaseNodes","description":"Knowledge base nodes"}},"required":["result"],"title":"KnowledgeBaseNodesResponse","type":"object"},"KnowledgeBaseNodes":{"properties":{"nodes":{"anyOf":[{"items":{"anyOf":[{"$ref":"#/components/schemas/KnowledgeBaseNodeFolder"},{"$ref":"#/components/schemas/KnowledgeBaseNodeFile"}]},"type":"array"},{"type":"null"}],"description":"knowledge base nodes","title":"Nodes"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"knowledge base nodes cursor","title":"Cursor"},"totalFileCount":{"description":"total number of files","title":"Totalfilecount","type":"integer"},"totalFolderCount":{"description":"total number of folders","title":"Totalfoldercount","type":"integer"}},"required":["totalFileCount","totalFolderCount"],"title":"KnowledgeBaseNodes","type":"object"},"KnowledgeBaseNodeFolder":{"properties":{"id":{"description":"knowledge base node id","title":"Id","type":"string"},"name":{"description":"knowledge base node name","title":"Name","type":"string"},"createdAt":{"description":"knowledge base node created at","title":"Createdat","type":"number"},"createdBy":{"anyOf":[{"$ref":"#/components/schemas/CreatedByAgent"},{"type":"null"}],"description":"agent who created this node"},"updatedAt":{"description":"knowledge base node updated at","title":"Updatedat","type":"number"},"nodeType":{"description":"knowledge base node type","title":"Nodetype","type":"string"},"parentFolder":{"anyOf":[{"$ref":"#/components/schemas/Folder"},{"type":"null"}],"description":"knowledge base node parent folder"},"breadcrumbs":{"description":"knowledge base node breadcrumbs","items":{"$ref":"#/components/schemas/Folder"},"title":"Breadcrumbs","type":"array"},"agentPermission":{"$ref":"#/components/schemas/AgentPermissionResponse","description":"Agent permission"},"userPermission":{"$ref":"#/components/schemas/UserPermissionResponse","description":"User permission"},"sourceType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"knowledge base folder external source type","title":"Sourcetype"}},"required":["id","name","createdAt","updatedAt","nodeType","breadcrumbs","agentPermission","userPermission"],"title":"KnowledgeBaseNodeFolder","type":"object"},"CreatedByAgent":{"properties":{"id":{"description":"agent id","title":"Id","type":"string"},"email":{"description":"agent email","title":"Email","type":"string"},"firstName":{"description":"agent first name","title":"Firstname","type":"string"},"lastName":{"description":"agent last name","title":"Lastname","type":"string"}},"required":["id","email","firstName","lastName"],"title":"CreatedByAgent","type":"object"},"Folder":{"properties":{"id":{"description":"folder id","title":"Id","type":"string"},"name":{"description":"folder name","title":"Name","type":"string"}},"required":["id","name"],"title":"Folder","type":"object"},"AgentPermissionResponse":{"description":"Response model for agent permission.","properties":{"accessAgents":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessAgent"},"type":"array"},{"type":"null"}],"description":"Agents with access to the object.","title":"Accessagents"},"accessPermissionGroups":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessPermissionGroupResponse"},"type":"array"},{"type":"null"}],"description":"Permission groups with access to the object, with names.","title":"Accesspermissiongroups"},"viewAccessToAgent":{"description":"Whether agents may view the object.","title":"Viewaccesstoagent","type":"boolean"}},"required":["viewAccessToAgent"],"title":"AgentPermissionResponse","type":"object"},"AccessAgent":{"properties":{"agentId":{"description":"エージェントID","title":"Agentid","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"アクセス方法"}},"required":["agentId","accessType"],"title":"AccessAgent","type":"object"},"ObjectAccessType":{"enum":["order_1_editor","order_2_reader"],"title":"ObjectAccessType","type":"string"},"AccessPermissionGroupResponse":{"description":"Response model for access permission group with name included.","properties":{"permissionGroupId":{"description":"The permission group ID","title":"Permissiongroupid","type":"string"},"permissionGroupName":{"description":"The permission group name","title":"Permissiongroupname","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"The access type"}},"required":["permissionGroupId","permissionGroupName","accessType"],"title":"AccessPermissionGroupResponse","type":"object"},"UserPermissionResponse":{"properties":{"ownUserIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"Customer-managed user IDs allowed by the access filters.","title":"Ownuserids"},"customerGroups":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"Customer group values allowed by the access filters.","title":"Customergroups"},"viewAccessToUser":{"description":"Whether users may view the object.","title":"Viewaccesstouser","type":"boolean"}},"required":["viewAccessToUser"],"title":"UserPermissionResponse","type":"object"},"KnowledgeBaseNodeFile":{"properties":{"id":{"description":"knowledge base node id","title":"Id","type":"string"},"name":{"description":"knowledge base node name","title":"Name","type":"string"},"createdAt":{"description":"knowledge base node created at","title":"Createdat","type":"number"},"createdBy":{"anyOf":[{"$ref":"#/components/schemas/CreatedByAgent"},{"type":"null"}],"description":"agent who created this node"},"updatedAt":{"description":"knowledge base node updated at","title":"Updatedat","type":"number"},"nodeType":{"description":"knowledge base node type","title":"Nodetype","type":"string"},"parentFolder":{"anyOf":[{"$ref":"#/components/schemas/Folder"},{"type":"null"}],"description":"knowledge base node parent folder"},"breadcrumbs":{"description":"knowledge base node breadcrumbs","items":{"$ref":"#/components/schemas/Folder"},"title":"Breadcrumbs","type":"array"},"agentPermission":{"$ref":"#/components/schemas/AgentPermissionResponse","description":"Agent permission"},"userPermission":{"$ref":"#/components/schemas/UserPermissionResponse","description":"User permission"},"piiDetected":{"default":false,"description":"Whether the document has at least one PII masking entity. False also includes documents that have not been checked for PII.","title":"Piidetected","type":"boolean"},"hashtags":{"description":"knowledge base hashtags","items":{"type":"string"},"title":"Hashtags","type":"array"},"status":{"description":"knowledge base status","title":"Status","type":"string"},"size":{"description":"knowledge base size","title":"Size","type":"integer"},"processState":{"description":"knowledge base process state","title":"Processstate","type":"string"},"properties":{"anyOf":[{"items":{"$ref":"#/components/schemas/KnowledgeBaseFileProperty"},"type":"array"},{"type":"null"}],"description":"knowledge base properties","title":"Properties"},"action":{"anyOf":[{"$ref":"#/components/schemas/KnowledgeBaseUploadAction"},{"type":"null"}],"description":"Upload result for this document: 'created', 'overwritten', 'skipped', or 'suffix_added'. Only set on upload responses."},"sourceType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"knowledge base document source type","title":"Sourcetype"}},"required":["id","name","createdAt","updatedAt","nodeType","breadcrumbs","agentPermission","userPermission","hashtags","status","size","processState"],"title":"KnowledgeBaseNodeFile","type":"object"},"KnowledgeBaseFileProperty":{"properties":{"key":{"description":"property key","title":"Key","type":"string"},"value":{"description":"property value","title":"Value","type":"string"}},"required":["key","value"],"title":"KnowledgeBaseFileProperty","type":"object"},"KnowledgeBaseUploadAction":{"enum":["created","overwritten","skipped","suffix_added"],"title":"KnowledgeBaseUploadAction","type":"string"},"KnowledgeBaseNodesRequest":{"properties":{"filter_":{"anyOf":[{"$ref":"#/components/schemas/KnowledgeBaseNodeFilter"},{"type":"null"}],"description":"The filter of the knowledge base node"},"filter":{"anyOf":[{"$ref":"#/components/schemas/KnowledgeBaseNodeFilter"},{"type":"null"}],"description":"The filter of the knowledge base node"},"order":{"allOf":[{"$ref":"#/components/schemas/KnowledgeBaseNodeOrder"}],"default":"updated_at_desc","description":"The order of the knowledge base node"},"limit":{"default":10,"description":"The limit of the knowledge base node","title":"Limit","type":"integer"},"after":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The after of the knowledge base node","title":"After"},"offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The offset of the knowledge base node","title":"Offset"}},"title":"KnowledgeBaseNodesRequest","type":"object"},"KnowledgeBaseNodeFilter":{"properties":{"parentFolderIds":{"anyOf":[{"items":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":"array"},{"type":"null"}],"title":"Parentfolderids"},"searchTerm":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Searchterm"},"hashtags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Hashtags"},"hashtagsSearchOperator":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hashtagssearchoperator"},"combinedHashtags":{"anyOf":[{"items":{"items":{"type":"string"},"type":"array"},"type":"array"},{"type":"null"}],"title":"Combinedhashtags"},"combinedHashtagsOperator":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Combinedhashtagsoperator"},"excludingHashtags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Excludinghashtags"},"excludingHashtagsSearchOperator":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Excludinghashtagssearchoperator"},"processState":{"anyOf":[{"items":{"$ref":"#/components/schemas/ProcessStateEnum"},"type":"array"},{"type":"null"}],"title":"Processstate"},"status":{"anyOf":[{"items":{"$ref":"#/components/schemas/KnowledgeBaseNodeOnOffState"},"type":"array"},{"type":"null"}],"title":"Status"},"nodeType":{"anyOf":[{"items":{"$ref":"#/components/schemas/KnowledgeBaseNodeType"},"type":"array"},{"type":"null"}],"title":"Nodetype"},"knowledgeBaseIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Knowledgebaseids"},"folderIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Folderids"},"ownership":{"anyOf":[{"items":{"$ref":"#/components/schemas/KnowledgeBaseNodeOwnership"},"type":"array"},{"type":"null"}],"title":"Ownership"},"ancestorIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Ancestorids"},"hasFaqCandidates":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Hasfaqcandidates"},"sourceTypes":{"anyOf":[{"items":{"$ref":"#/components/schemas/DocSourceEnum"},"type":"array"},{"type":"null"}],"title":"Sourcetypes"},"facetConditions":{"anyOf":[{"items":{"$ref":"#/components/schemas/FacetCondition"},"type":"array"},{"type":"null"}],"title":"Facetconditions"},"latestVersionOnly":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Latestversiononly"}},"title":"KnowledgeBaseNodeFilter","type":"object"},"ProcessStateEnum":{"enum":["initializing","parsing","parsing_fail","completed","retrying","post_parsing","post_parsing_fail","post_completed","post_retrying"],"title":"ProcessStateEnum","type":"string"},"KnowledgeBaseNodeOnOffState":{"enum":["on","off"],"title":"KnowledgeBaseNodeOnOffState","type":"string"},"KnowledgeBaseNodeType":{"enum":["file","folder"],"title":"KnowledgeBaseNodeType","type":"string"},"KnowledgeBaseNodeOwnership":{"enum":["personal","shared"],"title":"KnowledgeBaseNodeOwnership","type":"string"},"DocSourceEnum":{"enum":["onedrive","html","google-drive","confluence","sharepoint","notion","github","alli","data_integration_service","box","box_v2","google_drive_v2"],"title":"DocSourceEnum","type":"string"},"FacetCondition":{"description":"A single facet comparison the document corpus is narrowed by.\n\n`value` is the resolved comparison operand whose runtime type follows the facet's\nown value type (single string, number, or multi-select set). `None` carries the\n\"no operand\" case used by the EXISTS / NOT_EXISTS comparators.","properties":{"attribute":{"title":"Attribute","type":"string"},"comparator":{"$ref":"#/components/schemas/FacetComparator"},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Value"}},"required":["attribute","comparator"],"title":"FacetCondition","type":"object"},"FacetComparator":{"description":"Comparison operators for a facet filter condition.\n\nMirrors Knowledge Refinery's `FacetComparator` wire values — the `.value`\nstring is sent verbatim to the KR document-id collection endpoint.","enum":["eq","ne","gt","gte","lt","lte","in","nin","contain","like","exists","not_exists"],"title":"FacetComparator","type":"string"},"KnowledgeBaseNodeOrder":{"enum":["name_asc","name_desc","updated_at_asc","updated_at_desc","created_at_asc","created_at_desc","file_and_name_asc","file_and_name_desc","folder_and_name_asc","folder_and_name_desc"],"title":"KnowledgeBaseNodeOrder","type":"string"}}},"paths":{"/webapi/v2/knowledge_base_nodes/search":{"post":{"operationId":"django_server_knowledge_base_views_rest_knowledge_base_node_api_knowledge_base_nodes","summary":"ドキュメントの検索","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}],"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeBaseNodesResponse"}}}},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication failed. The API-KEY header is missing or invalid."},"403":{"description":"Access denied. The project is inactive or the request IP is not allowed."},"500":{"description":"Internal server error."}},"description":"ドキュメントメニュー内のドキュメントを検索します。","tags":["KnowledgeBase"],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/KnowledgeBaseNodesRequest"}],"default":{"filter_":null,"filter":null,"order":"updated_at_desc","limit":10,"after":null,"offset":null}}}},"required":false}}}}}
```

## POST /webapi/v2/knowledge\_base\_nodes/content\_search

> ドキュメント検索

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"KnowledgeBase","description":"User related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}},"schemas":{"KnowledgeBaseNodesResponse":{"properties":{"result":{"$ref":"#/components/schemas/KnowledgeBaseNodes","description":"Knowledge base nodes"}},"required":["result"],"title":"KnowledgeBaseNodesResponse","type":"object"},"KnowledgeBaseNodes":{"properties":{"nodes":{"anyOf":[{"items":{"anyOf":[{"$ref":"#/components/schemas/KnowledgeBaseNodeFolder"},{"$ref":"#/components/schemas/KnowledgeBaseNodeFile"}]},"type":"array"},{"type":"null"}],"description":"knowledge base nodes","title":"Nodes"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"knowledge base nodes cursor","title":"Cursor"},"totalFileCount":{"description":"total number of files","title":"Totalfilecount","type":"integer"},"totalFolderCount":{"description":"total number of folders","title":"Totalfoldercount","type":"integer"}},"required":["totalFileCount","totalFolderCount"],"title":"KnowledgeBaseNodes","type":"object"},"KnowledgeBaseNodeFolder":{"properties":{"id":{"description":"knowledge base node id","title":"Id","type":"string"},"name":{"description":"knowledge base node name","title":"Name","type":"string"},"createdAt":{"description":"knowledge base node created at","title":"Createdat","type":"number"},"createdBy":{"anyOf":[{"$ref":"#/components/schemas/CreatedByAgent"},{"type":"null"}],"description":"agent who created this node"},"updatedAt":{"description":"knowledge base node updated at","title":"Updatedat","type":"number"},"nodeType":{"description":"knowledge base node type","title":"Nodetype","type":"string"},"parentFolder":{"anyOf":[{"$ref":"#/components/schemas/Folder"},{"type":"null"}],"description":"knowledge base node parent folder"},"breadcrumbs":{"description":"knowledge base node breadcrumbs","items":{"$ref":"#/components/schemas/Folder"},"title":"Breadcrumbs","type":"array"},"agentPermission":{"$ref":"#/components/schemas/AgentPermissionResponse","description":"Agent permission"},"userPermission":{"$ref":"#/components/schemas/UserPermissionResponse","description":"User permission"},"sourceType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"knowledge base folder external source type","title":"Sourcetype"}},"required":["id","name","createdAt","updatedAt","nodeType","breadcrumbs","agentPermission","userPermission"],"title":"KnowledgeBaseNodeFolder","type":"object"},"CreatedByAgent":{"properties":{"id":{"description":"agent id","title":"Id","type":"string"},"email":{"description":"agent email","title":"Email","type":"string"},"firstName":{"description":"agent first name","title":"Firstname","type":"string"},"lastName":{"description":"agent last name","title":"Lastname","type":"string"}},"required":["id","email","firstName","lastName"],"title":"CreatedByAgent","type":"object"},"Folder":{"properties":{"id":{"description":"folder id","title":"Id","type":"string"},"name":{"description":"folder name","title":"Name","type":"string"}},"required":["id","name"],"title":"Folder","type":"object"},"AgentPermissionResponse":{"description":"Response model for agent permission.","properties":{"accessAgents":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessAgent"},"type":"array"},{"type":"null"}],"description":"Agents with access to the object.","title":"Accessagents"},"accessPermissionGroups":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessPermissionGroupResponse"},"type":"array"},{"type":"null"}],"description":"Permission groups with access to the object, with names.","title":"Accesspermissiongroups"},"viewAccessToAgent":{"description":"Whether agents may view the object.","title":"Viewaccesstoagent","type":"boolean"}},"required":["viewAccessToAgent"],"title":"AgentPermissionResponse","type":"object"},"AccessAgent":{"properties":{"agentId":{"description":"エージェントID","title":"Agentid","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"アクセス方法"}},"required":["agentId","accessType"],"title":"AccessAgent","type":"object"},"ObjectAccessType":{"enum":["order_1_editor","order_2_reader"],"title":"ObjectAccessType","type":"string"},"AccessPermissionGroupResponse":{"description":"Response model for access permission group with name included.","properties":{"permissionGroupId":{"description":"The permission group ID","title":"Permissiongroupid","type":"string"},"permissionGroupName":{"description":"The permission group name","title":"Permissiongroupname","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"The access type"}},"required":["permissionGroupId","permissionGroupName","accessType"],"title":"AccessPermissionGroupResponse","type":"object"},"UserPermissionResponse":{"properties":{"ownUserIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"Customer-managed user IDs allowed by the access filters.","title":"Ownuserids"},"customerGroups":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"Customer group values allowed by the access filters.","title":"Customergroups"},"viewAccessToUser":{"description":"Whether users may view the object.","title":"Viewaccesstouser","type":"boolean"}},"required":["viewAccessToUser"],"title":"UserPermissionResponse","type":"object"},"KnowledgeBaseNodeFile":{"properties":{"id":{"description":"knowledge base node id","title":"Id","type":"string"},"name":{"description":"knowledge base node name","title":"Name","type":"string"},"createdAt":{"description":"knowledge base node created at","title":"Createdat","type":"number"},"createdBy":{"anyOf":[{"$ref":"#/components/schemas/CreatedByAgent"},{"type":"null"}],"description":"agent who created this node"},"updatedAt":{"description":"knowledge base node updated at","title":"Updatedat","type":"number"},"nodeType":{"description":"knowledge base node type","title":"Nodetype","type":"string"},"parentFolder":{"anyOf":[{"$ref":"#/components/schemas/Folder"},{"type":"null"}],"description":"knowledge base node parent folder"},"breadcrumbs":{"description":"knowledge base node breadcrumbs","items":{"$ref":"#/components/schemas/Folder"},"title":"Breadcrumbs","type":"array"},"agentPermission":{"$ref":"#/components/schemas/AgentPermissionResponse","description":"Agent permission"},"userPermission":{"$ref":"#/components/schemas/UserPermissionResponse","description":"User permission"},"piiDetected":{"default":false,"description":"Whether the document has at least one PII masking entity. False also includes documents that have not been checked for PII.","title":"Piidetected","type":"boolean"},"hashtags":{"description":"knowledge base hashtags","items":{"type":"string"},"title":"Hashtags","type":"array"},"status":{"description":"knowledge base status","title":"Status","type":"string"},"size":{"description":"knowledge base size","title":"Size","type":"integer"},"processState":{"description":"knowledge base process state","title":"Processstate","type":"string"},"properties":{"anyOf":[{"items":{"$ref":"#/components/schemas/KnowledgeBaseFileProperty"},"type":"array"},{"type":"null"}],"description":"knowledge base properties","title":"Properties"},"action":{"anyOf":[{"$ref":"#/components/schemas/KnowledgeBaseUploadAction"},{"type":"null"}],"description":"Upload result for this document: 'created', 'overwritten', 'skipped', or 'suffix_added'. Only set on upload responses."},"sourceType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"knowledge base document source type","title":"Sourcetype"}},"required":["id","name","createdAt","updatedAt","nodeType","breadcrumbs","agentPermission","userPermission","hashtags","status","size","processState"],"title":"KnowledgeBaseNodeFile","type":"object"},"KnowledgeBaseFileProperty":{"properties":{"key":{"description":"property key","title":"Key","type":"string"},"value":{"description":"property value","title":"Value","type":"string"}},"required":["key","value"],"title":"KnowledgeBaseFileProperty","type":"object"},"KnowledgeBaseUploadAction":{"enum":["created","overwritten","skipped","suffix_added"],"title":"KnowledgeBaseUploadAction","type":"string"},"ContentSearchRequest":{"properties":{"searchTerm":{"description":"The search term of the knowledge base node","title":"Searchterm","type":"string"},"limit":{"default":10,"description":"The limit of the knowledge base node","exclusiveMinimum":0,"maximum":10000,"title":"Limit","type":"integer"},"after":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The after of the knowledge base node","title":"After"},"folderIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"The folder IDs of the knowledge base node","title":"Folderids"},"searchScope":{"allOf":[{"$ref":"#/components/schemas/SearchScopeEnum"}],"default":"both","description":"The search scope of the knowledge base node"}},"required":["searchTerm"],"title":"ContentSearchRequest","type":"object"},"SearchScopeEnum":{"enum":["title_only","content_only","both"],"title":"SearchScopeEnum","type":"string"}}},"paths":{"/webapi/v2/knowledge_base_nodes/content_search":{"post":{"operationId":"django_server_knowledge_base_views_rest_knowledge_base_node_api_content_search","summary":"ドキュメント検索","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}],"responses":{"200":{"description":"成功しました。","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeBaseNodesResponse"}}}},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication failed. The API-KEY header is missing or invalid."},"403":{"description":"Access denied. The project is inactive or the request IP is not allowed."},"500":{"description":"Internal server error."}},"description":"","tags":["KnowledgeBase"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentSearchRequest"}}},"required":true}}}}}
```

## Page Content Search

> This API allows you to search within document pages and return matching text with page numbers.\
> \
> \## Headers\
> \
> \- API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.\
> \- AGENT-EMAIL (string, optional): The email address of the agent performing the API call.\
> \- USER-EMAIL (string, optional): The email address to associate with the user.\
> \- OWN-USER-ID (string, optional): The user ID to identify or create a user.\
> \
> \## Request Body\
> \
> \- searchTerms (array\[string], required): The terms to search for.\
> \- folderIds (array\[string], optional): Folder IDs to search within.\
> \- knowledgeBaseIds (array\[string], optional): Knowledge base IDs to search within.\
> \- hashtags (array\[string], optional): Hashtags to filter by.\
> \- hashtagsOperator (string, optional): Operator for hashtag filter. Defaults to \*\*OR\*\*.\
> \- excludeHashtags (array\[string], optional): Hashtags to exclude from results.\
> \- excludeHashtagsOperator (string, optional): Operator for exclude hashtag filter. Defaults to \*\*OR\*\*.\
> \- topN (integer, optional): Number of top results per document. Defaults to \*\*1\*\*.\
> \- mergeSamePage (boolean, optional): Whether to merge content from the same page. Defaults to \*\*false\*\*.

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"KnowledgeBase","description":"User related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}},"schemas":{"PageContentSearchResponse":{"description":"Response model for page content search containing list of page content items with metadata.","properties":{"results":{"description":"List of page content items with metadata","items":{"$ref":"#/components/schemas/PageContentItem"},"title":"Results","type":"array"}},"required":["results"],"title":"PageContentSearchResponse","type":"object"},"PageContentItem":{"description":"Individual page content item with metadata.","properties":{"kbId":{"description":"Knowledge base ID","title":"Kbid","type":"string"},"title":{"description":"Document title","title":"Title","type":"string"},"text":{"description":"Page text content","title":"Text","type":"string"},"pageNo":{"description":"Page number","title":"Pageno","type":"integer"}},"required":["kbId","title","text","pageNo"],"title":"PageContentItem","type":"object"},"PageContentSearchRequest":{"properties":{"searchTerms":{"description":"The search terms for page content search","items":{"type":"string"},"title":"Searchterms","type":"array"},"folderIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"The folder IDs to search within","title":"Folderids"},"knowledgeBaseIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"The knowledge base IDs to search within","title":"Knowledgebaseids"},"hashtags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"The hashtags to filter by","title":"Hashtags"},"hashtagsOperator":{"default":"OR","description":"The hashtags operator (AND/OR)","title":"Hashtagsoperator","type":"string"},"excludeHashtags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"The hashtags to exclude","title":"Excludehashtags"},"excludeHashtagsOperator":{"default":"OR","description":"The exclude hashtags operator (AND/OR)","title":"Excludehashtagsoperator","type":"string"},"topN":{"default":1,"description":"The number of top results to return","exclusiveMinimum":0,"maximum":100,"title":"Topn","type":"integer"},"mergeSamePage":{"default":false,"description":"Whether to merge content from the same page","title":"Mergesamepage","type":"boolean"}},"required":["searchTerms"],"title":"PageContentSearchRequest","type":"object"}}},"paths":{"/webapi/v2/knowledge_base_nodes/page_content_search":{"post":{"operationId":"django_server_knowledge_base_views_rest_knowledge_base_node_api_page_content_search","summary":"Page Content Search","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageContentSearchResponse"}}}},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication failed. The API-KEY header is missing or invalid."},"403":{"description":"Access denied. The project is inactive or the request IP is not allowed."},"500":{"description":"Internal server error."}},"description":"This API allows you to search within document pages and return matching text with page numbers.\n\n## Headers\n\n- API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.\n- AGENT-EMAIL (string, optional): The email address of the agent performing the API call.\n- USER-EMAIL (string, optional): The email address to associate with the user.\n- OWN-USER-ID (string, optional): The user ID to identify or create a user.\n\n## Request Body\n\n- searchTerms (array[string], required): The terms to search for.\n- folderIds (array[string], optional): Folder IDs to search within.\n- knowledgeBaseIds (array[string], optional): Knowledge base IDs to search within.\n- hashtags (array[string], optional): Hashtags to filter by.\n- hashtagsOperator (string, optional): Operator for hashtag filter. Defaults to **OR**.\n- excludeHashtags (array[string], optional): Hashtags to exclude from results.\n- excludeHashtagsOperator (string, optional): Operator for exclude hashtag filter. Defaults to **OR**.\n- topN (integer, optional): Number of top results per document. Defaults to **1**.\n- mergeSamePage (boolean, optional): Whether to merge content from the same page. Defaults to **false**.","tags":["KnowledgeBase"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageContentSearchRequest"}}},"required":true}}}}}
```

## ドキュメントの情報を取得

> ドキュメントメニュー内のドキュメントのメタデータを取得します。

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"KnowledgeBase","description":"User related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}},"schemas":{"KnowledgeBaseNodeResponse":{"properties":{"result":{"anyOf":[{"$ref":"#/components/schemas/KnowledgeBaseNodeFolder"},{"$ref":"#/components/schemas/KnowledgeBaseNodeFile"}],"description":"Knowledge base node","title":"Result"}},"required":["result"],"title":"KnowledgeBaseNodeResponse","type":"object"},"KnowledgeBaseNodeFolder":{"properties":{"id":{"description":"knowledge base node id","title":"Id","type":"string"},"name":{"description":"knowledge base node name","title":"Name","type":"string"},"createdAt":{"description":"knowledge base node created at","title":"Createdat","type":"number"},"createdBy":{"anyOf":[{"$ref":"#/components/schemas/CreatedByAgent"},{"type":"null"}],"description":"agent who created this node"},"updatedAt":{"description":"knowledge base node updated at","title":"Updatedat","type":"number"},"nodeType":{"description":"knowledge base node type","title":"Nodetype","type":"string"},"parentFolder":{"anyOf":[{"$ref":"#/components/schemas/Folder"},{"type":"null"}],"description":"knowledge base node parent folder"},"breadcrumbs":{"description":"knowledge base node breadcrumbs","items":{"$ref":"#/components/schemas/Folder"},"title":"Breadcrumbs","type":"array"},"agentPermission":{"$ref":"#/components/schemas/AgentPermissionResponse","description":"Agent permission"},"userPermission":{"$ref":"#/components/schemas/UserPermissionResponse","description":"User permission"},"sourceType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"knowledge base folder external source type","title":"Sourcetype"}},"required":["id","name","createdAt","updatedAt","nodeType","breadcrumbs","agentPermission","userPermission"],"title":"KnowledgeBaseNodeFolder","type":"object"},"CreatedByAgent":{"properties":{"id":{"description":"agent id","title":"Id","type":"string"},"email":{"description":"agent email","title":"Email","type":"string"},"firstName":{"description":"agent first name","title":"Firstname","type":"string"},"lastName":{"description":"agent last name","title":"Lastname","type":"string"}},"required":["id","email","firstName","lastName"],"title":"CreatedByAgent","type":"object"},"Folder":{"properties":{"id":{"description":"folder id","title":"Id","type":"string"},"name":{"description":"folder name","title":"Name","type":"string"}},"required":["id","name"],"title":"Folder","type":"object"},"AgentPermissionResponse":{"description":"Response model for agent permission.","properties":{"accessAgents":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessAgent"},"type":"array"},{"type":"null"}],"description":"Agents with access to the object.","title":"Accessagents"},"accessPermissionGroups":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessPermissionGroupResponse"},"type":"array"},{"type":"null"}],"description":"Permission groups with access to the object, with names.","title":"Accesspermissiongroups"},"viewAccessToAgent":{"description":"Whether agents may view the object.","title":"Viewaccesstoagent","type":"boolean"}},"required":["viewAccessToAgent"],"title":"AgentPermissionResponse","type":"object"},"AccessAgent":{"properties":{"agentId":{"description":"エージェントID","title":"Agentid","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"アクセス方法"}},"required":["agentId","accessType"],"title":"AccessAgent","type":"object"},"ObjectAccessType":{"enum":["order_1_editor","order_2_reader"],"title":"ObjectAccessType","type":"string"},"AccessPermissionGroupResponse":{"description":"Response model for access permission group with name included.","properties":{"permissionGroupId":{"description":"The permission group ID","title":"Permissiongroupid","type":"string"},"permissionGroupName":{"description":"The permission group name","title":"Permissiongroupname","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"The access type"}},"required":["permissionGroupId","permissionGroupName","accessType"],"title":"AccessPermissionGroupResponse","type":"object"},"UserPermissionResponse":{"properties":{"ownUserIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"Customer-managed user IDs allowed by the access filters.","title":"Ownuserids"},"customerGroups":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"Customer group values allowed by the access filters.","title":"Customergroups"},"viewAccessToUser":{"description":"Whether users may view the object.","title":"Viewaccesstouser","type":"boolean"}},"required":["viewAccessToUser"],"title":"UserPermissionResponse","type":"object"},"KnowledgeBaseNodeFile":{"properties":{"id":{"description":"knowledge base node id","title":"Id","type":"string"},"name":{"description":"knowledge base node name","title":"Name","type":"string"},"createdAt":{"description":"knowledge base node created at","title":"Createdat","type":"number"},"createdBy":{"anyOf":[{"$ref":"#/components/schemas/CreatedByAgent"},{"type":"null"}],"description":"agent who created this node"},"updatedAt":{"description":"knowledge base node updated at","title":"Updatedat","type":"number"},"nodeType":{"description":"knowledge base node type","title":"Nodetype","type":"string"},"parentFolder":{"anyOf":[{"$ref":"#/components/schemas/Folder"},{"type":"null"}],"description":"knowledge base node parent folder"},"breadcrumbs":{"description":"knowledge base node breadcrumbs","items":{"$ref":"#/components/schemas/Folder"},"title":"Breadcrumbs","type":"array"},"agentPermission":{"$ref":"#/components/schemas/AgentPermissionResponse","description":"Agent permission"},"userPermission":{"$ref":"#/components/schemas/UserPermissionResponse","description":"User permission"},"piiDetected":{"default":false,"description":"Whether the document has at least one PII masking entity. False also includes documents that have not been checked for PII.","title":"Piidetected","type":"boolean"},"hashtags":{"description":"knowledge base hashtags","items":{"type":"string"},"title":"Hashtags","type":"array"},"status":{"description":"knowledge base status","title":"Status","type":"string"},"size":{"description":"knowledge base size","title":"Size","type":"integer"},"processState":{"description":"knowledge base process state","title":"Processstate","type":"string"},"properties":{"anyOf":[{"items":{"$ref":"#/components/schemas/KnowledgeBaseFileProperty"},"type":"array"},{"type":"null"}],"description":"knowledge base properties","title":"Properties"},"action":{"anyOf":[{"$ref":"#/components/schemas/KnowledgeBaseUploadAction"},{"type":"null"}],"description":"Upload result for this document: 'created', 'overwritten', 'skipped', or 'suffix_added'. Only set on upload responses."},"sourceType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"knowledge base document source type","title":"Sourcetype"}},"required":["id","name","createdAt","updatedAt","nodeType","breadcrumbs","agentPermission","userPermission","hashtags","status","size","processState"],"title":"KnowledgeBaseNodeFile","type":"object"},"KnowledgeBaseFileProperty":{"properties":{"key":{"description":"property key","title":"Key","type":"string"},"value":{"description":"property value","title":"Value","type":"string"}},"required":["key","value"],"title":"KnowledgeBaseFileProperty","type":"object"},"KnowledgeBaseUploadAction":{"enum":["created","overwritten","skipped","suffix_added"],"title":"KnowledgeBaseUploadAction","type":"string"}}},"paths":{"/webapi/v2/knowledge_base_nodes/{node_id}":{"get":{"operationId":"django_server_knowledge_base_views_rest_knowledge_base_node_api_knowledge_base_node","summary":"ドキュメントの情報を取得","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"},{"in":"path","name":"node_id","schema":{"title":"Node Id","type":"string"},"required":true}],"responses":{"200":{"description":"成功しました","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeBaseNodeResponse"}}}},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication failed. The API-KEY header is missing or invalid."},"403":{"description":"Access denied. The project is inactive or the request IP is not allowed."},"500":{"description":"Internal server error."}},"description":"ドキュメントメニュー内のドキュメントのメタデータを取得します。","tags":["KnowledgeBase"]}}}}
```

## ドキュメントを更新

> ドキュメントメニュー内のドキュメントの情報を更新します。

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"KnowledgeBase","description":"User related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}},"schemas":{"KnowledgeBaseNodeResponse":{"properties":{"result":{"anyOf":[{"$ref":"#/components/schemas/KnowledgeBaseNodeFolder"},{"$ref":"#/components/schemas/KnowledgeBaseNodeFile"}],"description":"Knowledge base node","title":"Result"}},"required":["result"],"title":"KnowledgeBaseNodeResponse","type":"object"},"KnowledgeBaseNodeFolder":{"properties":{"id":{"description":"knowledge base node id","title":"Id","type":"string"},"name":{"description":"knowledge base node name","title":"Name","type":"string"},"createdAt":{"description":"knowledge base node created at","title":"Createdat","type":"number"},"createdBy":{"anyOf":[{"$ref":"#/components/schemas/CreatedByAgent"},{"type":"null"}],"description":"agent who created this node"},"updatedAt":{"description":"knowledge base node updated at","title":"Updatedat","type":"number"},"nodeType":{"description":"knowledge base node type","title":"Nodetype","type":"string"},"parentFolder":{"anyOf":[{"$ref":"#/components/schemas/Folder"},{"type":"null"}],"description":"knowledge base node parent folder"},"breadcrumbs":{"description":"knowledge base node breadcrumbs","items":{"$ref":"#/components/schemas/Folder"},"title":"Breadcrumbs","type":"array"},"agentPermission":{"$ref":"#/components/schemas/AgentPermissionResponse","description":"Agent permission"},"userPermission":{"$ref":"#/components/schemas/UserPermissionResponse","description":"User permission"},"sourceType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"knowledge base folder external source type","title":"Sourcetype"}},"required":["id","name","createdAt","updatedAt","nodeType","breadcrumbs","agentPermission","userPermission"],"title":"KnowledgeBaseNodeFolder","type":"object"},"CreatedByAgent":{"properties":{"id":{"description":"agent id","title":"Id","type":"string"},"email":{"description":"agent email","title":"Email","type":"string"},"firstName":{"description":"agent first name","title":"Firstname","type":"string"},"lastName":{"description":"agent last name","title":"Lastname","type":"string"}},"required":["id","email","firstName","lastName"],"title":"CreatedByAgent","type":"object"},"Folder":{"properties":{"id":{"description":"folder id","title":"Id","type":"string"},"name":{"description":"folder name","title":"Name","type":"string"}},"required":["id","name"],"title":"Folder","type":"object"},"AgentPermissionResponse":{"description":"Response model for agent permission.","properties":{"accessAgents":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessAgent"},"type":"array"},{"type":"null"}],"description":"Agents with access to the object.","title":"Accessagents"},"accessPermissionGroups":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessPermissionGroupResponse"},"type":"array"},{"type":"null"}],"description":"Permission groups with access to the object, with names.","title":"Accesspermissiongroups"},"viewAccessToAgent":{"description":"Whether agents may view the object.","title":"Viewaccesstoagent","type":"boolean"}},"required":["viewAccessToAgent"],"title":"AgentPermissionResponse","type":"object"},"AccessAgent":{"properties":{"agentId":{"description":"エージェントID","title":"Agentid","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"アクセス方法"}},"required":["agentId","accessType"],"title":"AccessAgent","type":"object"},"ObjectAccessType":{"enum":["order_1_editor","order_2_reader"],"title":"ObjectAccessType","type":"string"},"AccessPermissionGroupResponse":{"description":"Response model for access permission group with name included.","properties":{"permissionGroupId":{"description":"The permission group ID","title":"Permissiongroupid","type":"string"},"permissionGroupName":{"description":"The permission group name","title":"Permissiongroupname","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"The access type"}},"required":["permissionGroupId","permissionGroupName","accessType"],"title":"AccessPermissionGroupResponse","type":"object"},"UserPermissionResponse":{"properties":{"ownUserIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"Customer-managed user IDs allowed by the access filters.","title":"Ownuserids"},"customerGroups":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"Customer group values allowed by the access filters.","title":"Customergroups"},"viewAccessToUser":{"description":"Whether users may view the object.","title":"Viewaccesstouser","type":"boolean"}},"required":["viewAccessToUser"],"title":"UserPermissionResponse","type":"object"},"KnowledgeBaseNodeFile":{"properties":{"id":{"description":"knowledge base node id","title":"Id","type":"string"},"name":{"description":"knowledge base node name","title":"Name","type":"string"},"createdAt":{"description":"knowledge base node created at","title":"Createdat","type":"number"},"createdBy":{"anyOf":[{"$ref":"#/components/schemas/CreatedByAgent"},{"type":"null"}],"description":"agent who created this node"},"updatedAt":{"description":"knowledge base node updated at","title":"Updatedat","type":"number"},"nodeType":{"description":"knowledge base node type","title":"Nodetype","type":"string"},"parentFolder":{"anyOf":[{"$ref":"#/components/schemas/Folder"},{"type":"null"}],"description":"knowledge base node parent folder"},"breadcrumbs":{"description":"knowledge base node breadcrumbs","items":{"$ref":"#/components/schemas/Folder"},"title":"Breadcrumbs","type":"array"},"agentPermission":{"$ref":"#/components/schemas/AgentPermissionResponse","description":"Agent permission"},"userPermission":{"$ref":"#/components/schemas/UserPermissionResponse","description":"User permission"},"piiDetected":{"default":false,"description":"Whether the document has at least one PII masking entity. False also includes documents that have not been checked for PII.","title":"Piidetected","type":"boolean"},"hashtags":{"description":"knowledge base hashtags","items":{"type":"string"},"title":"Hashtags","type":"array"},"status":{"description":"knowledge base status","title":"Status","type":"string"},"size":{"description":"knowledge base size","title":"Size","type":"integer"},"processState":{"description":"knowledge base process state","title":"Processstate","type":"string"},"properties":{"anyOf":[{"items":{"$ref":"#/components/schemas/KnowledgeBaseFileProperty"},"type":"array"},{"type":"null"}],"description":"knowledge base properties","title":"Properties"},"action":{"anyOf":[{"$ref":"#/components/schemas/KnowledgeBaseUploadAction"},{"type":"null"}],"description":"Upload result for this document: 'created', 'overwritten', 'skipped', or 'suffix_added'. Only set on upload responses."},"sourceType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"knowledge base document source type","title":"Sourcetype"}},"required":["id","name","createdAt","updatedAt","nodeType","breadcrumbs","agentPermission","userPermission","hashtags","status","size","processState"],"title":"KnowledgeBaseNodeFile","type":"object"},"KnowledgeBaseFileProperty":{"properties":{"key":{"description":"property key","title":"Key","type":"string"},"value":{"description":"property value","title":"Value","type":"string"}},"required":["key","value"],"title":"KnowledgeBaseFileProperty","type":"object"},"KnowledgeBaseUploadAction":{"enum":["created","overwritten","skipped","suffix_added"],"title":"KnowledgeBaseUploadAction","type":"string"},"UpdateKnowledgeBaseNodeRequest":{"additionalProperties":false,"properties":{"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ナレッジベースノードのタイトル","title":"Title"},"hashtags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"ハッシュタグ","title":"Hashtags"},"isOverwriteFolderAccess":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"The overwrite folder access flag of the knowledge base node","title":"Isoverwritefolderaccess"},"accessPermissionGroups":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessPermissionGroup"},"type":"array"},{"type":"null"}],"description":"The access permission groups of the knowledge base node","title":"Accesspermissiongroups"},"accessAgents":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessAgent"},"type":"array"},{"type":"null"}],"description":"The access agents of the knowledge base node","title":"Accessagents"},"accessUserFilters":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessUserFilter"},"type":"array"},{"type":"null"}],"description":"The access user filters of the knowledge base node","title":"Accessuserfilters"},"viewAccessToAgent":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"The view access to agent flag of the knowledge base node","title":"Viewaccesstoagent"},"viewAccessToUser":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"The view access to user flag of the knowledge base node","title":"Viewaccesstouser"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/KnowledgeBaseFileProperty"},"description":"ナレッジベースノードに付与するメタデータ情報","title":"Properties"}},"title":"UpdateKnowledgeBaseNodeRequest","type":"object"},"AccessPermissionGroup":{"properties":{"permissionGroupId":{"description":"アクセス許可グループのグループID","title":"Permissiongroupid","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"アクセス許可グループの権限種別"}},"required":["permissionGroupId","accessType"],"title":"AccessPermissionGroup","type":"object"},"AccessUserFilter":{"properties":{"variableName":{"$ref":"#/components/schemas/AccessUserFilterEnum","description":"フィルターの変数名"},"value":{"description":"フィルターの値","title":"Value","type":"string"}},"required":["variableName","value"],"title":"AccessUserFilter","type":"object"},"AccessUserFilterEnum":{"description":"システム変数以外の変数を追加する場合は、再設計が必要です。","enum":["CUSTOMER_ID","CUSTOMER_GROUP"],"title":"AccessUserFilterEnum","type":"string"}}},"paths":{"/webapi/v2/knowledge_base_nodes/{node_id}":{"put":{"operationId":"django_server_knowledge_base_views_rest_knowledge_base_node_api_update_knowledge_base_node","summary":"ドキュメントを更新","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"},{"in":"path","name":"node_id","schema":{"title":"Node Id","type":"string"},"required":true}],"responses":{"200":{"description":"成功しました","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeBaseNodeResponse"}}}},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication failed. The API-KEY header is missing or invalid."},"403":{"description":"Access denied. The project is inactive or the request IP is not allowed."},"500":{"description":"Internal server error."}},"description":"ドキュメントメニュー内のドキュメントの情報を更新します。","tags":["KnowledgeBase"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateKnowledgeBaseNodeRequest"}}},"required":true}}}}}
```

## ドキュメントを削除

> ドキュメントメニュー内のドキュメントを削除します。

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"KnowledgeBase","description":"User related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/v2/knowledge_base_nodes/{node_id}":{"delete":{"operationId":"django_server_knowledge_base_views_rest_knowledge_base_node_api_delete_knowledge_base_nodes","summary":"ドキュメントを削除","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"},{"in":"path","name":"node_id","schema":{"title":"Node Id","type":"string"},"required":true}],"responses":{"200":{"description":"削除に成功しました"},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication failed. The API-KEY header is missing or invalid."},"403":{"description":"Access denied. The project is inactive or the request IP is not allowed."},"500":{"description":"Internal server error."}},"description":"ドキュメントメニュー内のドキュメントを削除します。","tags":["KnowledgeBase"]}}}}
```

## Knowledge Base Node Preview

> Get preview of a knowledge base node with HTML and PDF information.\
> \
> Args:\
>     request: HTTP request object\
>     node\_id: Global ID of the knowledge base node\
>     page\_no: Page number to preview (default: 1)\
> \
> Returns:\
>     KnowledgeBasePreviewResponse containing HTML and PDF preview data

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"KnowledgeBase","description":"User related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}},"schemas":{"KnowledgeBasePreviewResponse":{"description":"Response model for knowledge base preview containing HTML and PDF information.","properties":{"html":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"HTML preview of the knowledge base","title":"Html"},"pdfUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"PDF preview of the knowledge base","title":"Pdfurl"},"imageUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Image preview of the knowledge base","title":"Imageurl"},"previewUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Preview URL of the knowledge base","title":"Previewurl"},"totalPreviewCount":{"default":0,"description":"Total preview count of the knowledge base","title":"Totalpreviewcount","type":"integer"},"piiMasked":{"default":false,"description":"Whether the preview is hidden due to PII masking","title":"Piimasked","type":"boolean"}},"title":"KnowledgeBasePreviewResponse","type":"object"}}},"paths":{"/webapi/v2/knowledge_base_nodes/{node_id}/preview":{"get":{"operationId":"django_server_knowledge_base_views_rest_knowledge_base_node_api_knowledge_base_node_preview","summary":"Knowledge Base Node Preview","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"},{"in":"path","name":"node_id","schema":{"title":"Node Id","type":"string"},"required":true},{"in":"query","name":"page_no","schema":{"default":1,"title":"Page No","type":"integer"},"required":false}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeBasePreviewResponse"}}}},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication failed. The API-KEY header is missing or invalid."},"403":{"description":"Access denied. The project is inactive or the request IP is not allowed."},"500":{"description":"Internal server error."}},"description":"Get preview of a knowledge base node with HTML and PDF information.\n\nArgs:\n    request: HTTP request object\n    node_id: Global ID of the knowledge base node\n    page_no: Page number to preview (default: 1)\n\nReturns:\n    KnowledgeBasePreviewResponse containing HTML and PDF preview data","tags":["KnowledgeBase"]}}}}
```

## Knowledge Base Node Text

> Get text content of a knowledge base node from parsed pages.\
> \
> Args:\
>     request: HTTP request object\
>     node\_id: Global ID of the knowledge base node\
>     limit: Optional maximum number of pages to return\
>     offset: Optional number of pages to skip from the beginning\
> \
> Returns:\
>     HttpResponse containing plain text content from KnowledgeBaseParsedPage

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"KnowledgeBase","description":"User related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/v2/knowledge_base_nodes/{node_id}/text":{"get":{"operationId":"django_server_knowledge_base_views_rest_knowledge_base_node_api_knowledge_base_node_text","summary":"Knowledge Base Node Text","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"},{"in":"path","name":"node_id","schema":{"title":"Node Id","type":"string"},"required":true},{"in":"query","name":"limit","schema":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"title":"Limit"},"required":false},{"in":"query","name":"offset","schema":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"title":"Offset"},"required":false}],"responses":{"200":{"description":"OK"},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication failed. The API-KEY header is missing or invalid."},"403":{"description":"Access denied. The project is inactive or the request IP is not allowed."},"500":{"description":"Internal server error."}},"description":"Get text content of a knowledge base node from parsed pages.\n\nArgs:\n    request: HTTP request object\n    node_id: Global ID of the knowledge base node\n    limit: Optional maximum number of pages to return\n    offset: Optional number of pages to skip from the beginning\n\nReturns:\n    HttpResponse containing plain text content from KnowledgeBaseParsedPage","tags":["KnowledgeBase"]}}}}
```

## Knowledge Base Node Download

> Download original file of a knowledge base node.\
> \
> Args:\
>     request: HTTP request object\
>     node\_id: Global ID of the knowledge base node\
> \
> Returns:\
>     FileResponse containing the original file for download

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"KnowledgeBase","description":"User related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/v2/knowledge_base_nodes/{node_id}/download":{"get":{"operationId":"django_server_knowledge_base_views_rest_knowledge_base_node_api_knowledge_base_node_download","summary":"Knowledge Base Node Download","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"},{"in":"path","name":"node_id","schema":{"title":"Node Id","type":"string"},"required":true}],"responses":{"200":{"description":"OK"},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication failed. The API-KEY header is missing or invalid."},"403":{"description":"Access denied. The project is inactive or the request IP is not allowed."},"500":{"description":"Internal server error."}},"description":"Download original file of a knowledge base node.\n\nArgs:\n    request: HTTP request object\n    node_id: Global ID of the knowledge base node\n\nReturns:\n    FileResponse containing the original file for download","tags":["KnowledgeBase"]}}}}
```

## フォルダを作成

> ドキュメントメニューにフォルダを追加します。

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"KnowledgeBase","description":"User related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}},"schemas":{"FolderResponse":{"properties":{"id":{"title":"Id","type":"string"},"name":{"title":"Name","type":"string"},"createdAt":{"title":"Createdat","type":"number"},"updatedAt":{"title":"Updatedat","type":"number"},"parentFolderId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parentfolderid"},"folderSize":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Foldersize"}},"required":["id","name","createdAt","updatedAt"],"title":"FolderResponse","type":"object"},"CreateFolderRequest":{"properties":{"name":{"maxLength":50,"title":"Name","type":"string"},"parentFolderId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parentfolderid"},"followParentFolderPermission":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"title":"Followparentfolderpermission"},"permissionGroupEditors":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Permissiongroupeditors"},"permissionGroupViewers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Permissiongroupviewers"},"agentEditors":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Agenteditors"},"agentViewers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Agentviewers"},"userViewers":{"anyOf":[{"$ref":"#/components/schemas/UserAccessPermissionRequest"},{"type":"null"}]},"allowOtherAgentsView":{"default":true,"title":"Allowotheragentsview","type":"boolean"},"allowOtherUsersView":{"default":true,"title":"Allowotherusersview","type":"boolean"}},"required":["name"],"title":"CreateFolderRequest","type":"object"},"UserAccessPermissionRequest":{"properties":{"customerIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Customerids"},"customerGroupIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Customergroupids"}},"title":"UserAccessPermissionRequest","type":"object"}}},"paths":{"/webapi/v2/folders":{"post":{"operationId":"django_server_knowledge_base_views_rest_folder_api_create_folder","summary":"フォルダを作成","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}],"responses":{"200":{"description":"正常に作成されました。","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FolderResponse"}}}},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication failed. The API-KEY header is missing or invalid."},"403":{"description":"Access denied. The project is inactive or the request IP is not allowed."},"500":{"description":"Internal server error."}},"description":"ドキュメントメニューにフォルダを追加します。","tags":["KnowledgeBase"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFolderRequest"}}},"required":true}}}}}
```

## フォルダを取得

> IDを指定してフォルダを1件取得します。フォルダサイズ情報を含みます。

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"KnowledgeBase","description":"User related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}},"schemas":{"FolderResponse":{"properties":{"id":{"title":"Id","type":"string"},"name":{"title":"Name","type":"string"},"createdAt":{"title":"Createdat","type":"number"},"updatedAt":{"title":"Updatedat","type":"number"},"parentFolderId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parentfolderid"},"folderSize":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Foldersize"}},"required":["id","name","createdAt","updatedAt"],"title":"FolderResponse","type":"object"}}},"paths":{"/webapi/v2/folders/{folder_id}":{"get":{"operationId":"django_server_knowledge_base_views_rest_folder_api_get_folder","summary":"フォルダを取得","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"},{"in":"path","name":"folder_id","schema":{"title":"Folder Id","type":"string"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FolderResponse"}}}},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication failed. The API-KEY header is missing or invalid."},"403":{"description":"Access denied. The project is inactive or the request IP is not allowed."},"500":{"description":"Internal server error."}},"description":"IDを指定してフォルダを1件取得します。フォルダサイズ情報を含みます。","tags":["KnowledgeBase"]}}}}
```

## フォルダを更新

> This API allows you to update a folder's name, access control, and permission settings.\
> \
> \## Headers\
> \
> \- API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.\
> \- AGENT-EMAIL (string, optional): The email address of the agent performing the API call.\
> \- USER-EMAIL (string, optional): The email address to associate with the user.\
> \- OWN-USER-ID (string, optional): The user ID to identify or create a user.\
> \
> \## Request Body\
> \
> \- name (string, required): The new name for the folder. Maximum 50 characters.\
> \- permissionGroupEditors (array\[string], optional): Permission group IDs to grant editor access.\
> \- permissionGroupViewers (array\[string], optional): Permission group IDs to grant viewer access.\
> \- agentEditors (array\[string], optional): Agent IDs to grant editor access.\
> \- agentViewers (array\[string], optional): Agent IDs to grant viewer access.\
> \- userViewers (object, optional): User access filters with \`customerIds\` and \`customerGroupIds\` arrays.\
> \- allowOtherAgentsView (boolean, optional): Whether other agents can view.\
> \- allowOtherUsersView (boolean, optional): Whether other users can view.

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"KnowledgeBase","description":"User related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}},"schemas":{"FolderResponse":{"properties":{"id":{"title":"Id","type":"string"},"name":{"title":"Name","type":"string"},"createdAt":{"title":"Createdat","type":"number"},"updatedAt":{"title":"Updatedat","type":"number"},"parentFolderId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parentfolderid"},"folderSize":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Foldersize"}},"required":["id","name","createdAt","updatedAt"],"title":"FolderResponse","type":"object"},"UpdateFolderRequest":{"properties":{"name":{"maxLength":50,"title":"Name","type":"string"},"permissionGroupEditors":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Permissiongroupeditors"},"permissionGroupViewers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Permissiongroupviewers"},"agentEditors":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Agenteditors"},"agentViewers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Agentviewers"},"userViewers":{"anyOf":[{"$ref":"#/components/schemas/UserAccessPermissionRequest"},{"type":"null"}]},"allowOtherAgentsView":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Allowotheragentsview"},"allowOtherUsersView":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Allowotherusersview"}},"required":["name"],"title":"UpdateFolderRequest","type":"object"},"UserAccessPermissionRequest":{"properties":{"customerIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Customerids"},"customerGroupIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Customergroupids"}},"title":"UserAccessPermissionRequest","type":"object"}}},"paths":{"/webapi/v2/folders/{folder_id}":{"put":{"operationId":"django_server_knowledge_base_views_rest_folder_api_update_folder","summary":"フォルダを更新","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"},{"in":"path","name":"folder_id","schema":{"title":"Folder Id","type":"string"},"required":true}],"responses":{"200":{"description":"正常に更新されました。","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FolderResponse"}}}},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication failed. The API-KEY header is missing or invalid."},"403":{"description":"Access denied. The project is inactive or the request IP is not allowed."},"500":{"description":"Internal server error."}},"description":"This API allows you to update a folder's name, access control, and permission settings.\n\n## Headers\n\n- API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.\n- AGENT-EMAIL (string, optional): The email address of the agent performing the API call.\n- USER-EMAIL (string, optional): The email address to associate with the user.\n- OWN-USER-ID (string, optional): The user ID to identify or create a user.\n\n## Request Body\n\n- name (string, required): The new name for the folder. Maximum 50 characters.\n- permissionGroupEditors (array[string], optional): Permission group IDs to grant editor access.\n- permissionGroupViewers (array[string], optional): Permission group IDs to grant viewer access.\n- agentEditors (array[string], optional): Agent IDs to grant editor access.\n- agentViewers (array[string], optional): Agent IDs to grant viewer access.\n- userViewers (object, optional): User access filters with `customerIds` and `customerGroupIds` arrays.\n- allowOtherAgentsView (boolean, optional): Whether other agents can view.\n- allowOtherUsersView (boolean, optional): Whether other users can view.","tags":["KnowledgeBase"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFolderRequest"}}},"required":true}}}}}
```

## フォルダを削除

> This API allows you to delete a folder. Optionally move contained documents to the root folder instead of deleting them.\
> \
> \## Headers\
> \
> \- API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.\
> \- AGENT-EMAIL (string, optional): The email address of the agent performing the API call.\
> \- USER-EMAIL (string, optional): The email address to associate with the user.\
> \- OWN-USER-ID (string, optional): The user ID to identify or create a user.\
> \
> \## Query Parameters\
> \
> \- move\_docs\_out\_of\_folder (boolean, optional): If true, moves documents to the root folder instead of deleting them. Defaults to \*\*false\*\*.

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"KnowledgeBase","description":"User related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/v2/folders/{folder_id}":{"delete":{"operationId":"django_server_knowledge_base_views_rest_folder_api_delete_folder","summary":"フォルダを削除","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"},{"in":"path","name":"folder_id","schema":{"title":"Folder Id","type":"string"},"required":true},{"in":"query","name":"move_docs_out_of_folder","schema":{"default":false,"title":"Move Docs Out Of Folder","type":"boolean"},"required":false}],"responses":{"200":{"description":"OK"},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication failed. The API-KEY header is missing or invalid."},"403":{"description":"Access denied. The project is inactive or the request IP is not allowed."},"500":{"description":"Internal server error."}},"description":"This API allows you to delete a folder. Optionally move contained documents to the root folder instead of deleting them.\n\n## Headers\n\n- API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.\n- AGENT-EMAIL (string, optional): The email address of the agent performing the API call.\n- USER-EMAIL (string, optional): The email address to associate with the user.\n- OWN-USER-ID (string, optional): The user ID to identify or create a user.\n\n## Query Parameters\n\n- move_docs_out_of_folder (boolean, optional): If true, moves documents to the root folder instead of deleting them. Defaults to **false**.","tags":["KnowledgeBase"]}}}}
```

## Create Personal Folder

> This API allows you to create a folder in the requesting user's personal document box.\
> \
> \## Headers\
> \
> \- API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.\
> \- AGENT-EMAIL (string): The email address of the project member whose personal document box is being\
>   opened. \*\*Required on Works projects\*\*, where it is what names the box; omitting it there is\
>   rejected rather than resolved to the project owner.\
> \- USER-EMAIL (string): The email address to associate with the user. \*\*Required on Works projects\*\*,\
>   where it is what puts the request into user scope — AGENT-EMAIL alone resolves no user.\
> \- OWN-USER-ID (string): The user ID to identify or create a user. \*\*Required on other project types\*\*,\
>   where it names the acting user. On Works it is accepted in place of USER-EMAIL.\
> \
> So a Works call sends \*\*AGENT-EMAIL and USER-EMAIL together\*\*, and any other project sends\
> \*\*OWN-USER-ID\*\*. Every endpoint acts on the resolved user's own document box; a request that\
> resolves no user is rejected — never redirected to the shared box, nor to the project owner's.\
> \
> \## Request Body\
> \
> \- name (string, required): The name of the folder. Maximum 50 characters. Must be unique among the\
>   caller's own folders under the same parent.\
> \- parentFolderId (string, optional): The parent folder ID. Null creates the folder at the personal\
>   document box root. When given, it must be one of the caller's own personal folders — a shared\
>   folder is rejected.

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"KnowledgeBase","description":"User related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}},"schemas":{"FolderResponse":{"properties":{"id":{"title":"Id","type":"string"},"name":{"title":"Name","type":"string"},"createdAt":{"title":"Createdat","type":"number"},"updatedAt":{"title":"Updatedat","type":"number"},"parentFolderId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parentfolderid"},"folderSize":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Foldersize"}},"required":["id","name","createdAt","updatedAt"],"title":"FolderResponse","type":"object"},"CreatePersonalFolderRequest":{"properties":{"name":{"description":"The name of the folder. Maximum 50 characters.","maxLength":50,"title":"Name","type":"string"},"parentFolderId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The parent folder ID. Null creates the folder at the personal document box root.","title":"Parentfolderid"}},"required":["name"],"title":"CreatePersonalFolderRequest","type":"object"}}},"paths":{"/webapi/v2/personal_folders":{"post":{"operationId":"django_server_knowledge_base_views_rest_personal_folder_api_create_personal_folder","summary":"Create Personal Folder","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FolderResponse"}}}},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication failed. The API-KEY header is missing or invalid."},"403":{"description":"Access denied. The project is inactive or the request IP is not allowed."},"500":{"description":"Internal server error."}},"description":"This API allows you to create a folder in the requesting user's personal document box.\n\n## Headers\n\n- API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.\n- AGENT-EMAIL (string): The email address of the project member whose personal document box is being\n  opened. **Required on Works projects**, where it is what names the box; omitting it there is\n  rejected rather than resolved to the project owner.\n- USER-EMAIL (string): The email address to associate with the user. **Required on Works projects**,\n  where it is what puts the request into user scope — AGENT-EMAIL alone resolves no user.\n- OWN-USER-ID (string): The user ID to identify or create a user. **Required on other project types**,\n  where it names the acting user. On Works it is accepted in place of USER-EMAIL.\n\nSo a Works call sends **AGENT-EMAIL and USER-EMAIL together**, and any other project sends\n**OWN-USER-ID**. Every endpoint acts on the resolved user's own document box; a request that\nresolves no user is rejected — never redirected to the shared box, nor to the project owner's.\n\n## Request Body\n\n- name (string, required): The name of the folder. Maximum 50 characters. Must be unique among the\n  caller's own folders under the same parent.\n- parentFolderId (string, optional): The parent folder ID. Null creates the folder at the personal\n  document box root. When given, it must be one of the caller's own personal folders — a shared\n  folder is rejected.","tags":["KnowledgeBase"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePersonalFolderRequest"}}},"required":true}}}}}
```

## Rename Personal Folder

> This API allows you to rename a folder in the requesting user's personal document box.\
> \
> Only a folder the caller owns can be renamed; a shared folder or another user's personal folder is\
> rejected. Use the move API to relocate a folder — the parent cannot be changed here.\
> \
> \## Headers\
> \
> \- API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.\
> \- AGENT-EMAIL (string): The email address of the project member whose personal document box is being\
>   opened. \*\*Required on Works projects\*\*, where it is what names the box; omitting it there is\
>   rejected rather than resolved to the project owner.\
> \- USER-EMAIL (string): The email address to associate with the user. \*\*Required on Works projects\*\*,\
>   where it is what puts the request into user scope — AGENT-EMAIL alone resolves no user.\
> \- OWN-USER-ID (string): The user ID to identify or create a user. \*\*Required on other project types\*\*,\
>   where it names the acting user. On Works it is accepted in place of USER-EMAIL.\
> \
> So a Works call sends \*\*AGENT-EMAIL and USER-EMAIL together\*\*, and any other project sends\
> \*\*OWN-USER-ID\*\*. Every endpoint acts on the resolved user's own document box; a request that\
> resolves no user is rejected — never redirected to the shared box, nor to the project owner's.\
> \
> \## Request Body\
> \
> \- name (string, required): The new name for the folder. Maximum 50 characters. Must be unique among\
>   the caller's own folders under the same parent.

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"KnowledgeBase","description":"User related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}},"schemas":{"FolderResponse":{"properties":{"id":{"title":"Id","type":"string"},"name":{"title":"Name","type":"string"},"createdAt":{"title":"Createdat","type":"number"},"updatedAt":{"title":"Updatedat","type":"number"},"parentFolderId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parentfolderid"},"folderSize":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Foldersize"}},"required":["id","name","createdAt","updatedAt"],"title":"FolderResponse","type":"object"},"UpdatePersonalFolderRequest":{"properties":{"name":{"description":"The new name for the folder. Maximum 50 characters.","maxLength":50,"title":"Name","type":"string"}},"required":["name"],"title":"UpdatePersonalFolderRequest","type":"object"}}},"paths":{"/webapi/v2/personal_folders/{folder_id}":{"put":{"operationId":"django_server_knowledge_base_views_rest_personal_folder_api_update_personal_folder","summary":"Rename Personal Folder","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"},{"in":"path","name":"folder_id","schema":{"title":"Folder Id","type":"string"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FolderResponse"}}}},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication failed. The API-KEY header is missing or invalid."},"403":{"description":"Access denied. The project is inactive or the request IP is not allowed."},"500":{"description":"Internal server error."}},"description":"This API allows you to rename a folder in the requesting user's personal document box.\n\nOnly a folder the caller owns can be renamed; a shared folder or another user's personal folder is\nrejected. Use the move API to relocate a folder — the parent cannot be changed here.\n\n## Headers\n\n- API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.\n- AGENT-EMAIL (string): The email address of the project member whose personal document box is being\n  opened. **Required on Works projects**, where it is what names the box; omitting it there is\n  rejected rather than resolved to the project owner.\n- USER-EMAIL (string): The email address to associate with the user. **Required on Works projects**,\n  where it is what puts the request into user scope — AGENT-EMAIL alone resolves no user.\n- OWN-USER-ID (string): The user ID to identify or create a user. **Required on other project types**,\n  where it names the acting user. On Works it is accepted in place of USER-EMAIL.\n\nSo a Works call sends **AGENT-EMAIL and USER-EMAIL together**, and any other project sends\n**OWN-USER-ID**. Every endpoint acts on the resolved user's own document box; a request that\nresolves no user is rejected — never redirected to the shared box, nor to the project owner's.\n\n## Request Body\n\n- name (string, required): The new name for the folder. Maximum 50 characters. Must be unique among\n  the caller's own folders under the same parent.","tags":["KnowledgeBase"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePersonalFolderRequest"}}},"required":true}}}}}
```

## Delete Personal Folder

> This API allows you to delete a folder in the requesting user's personal document box.\
> \
> The folder and everything below it — subfolders and documents — are deleted. Only a folder the\
> caller owns can be deleted; a shared folder or another user's personal folder is rejected.\
> \
> \## Headers\
> \
> \- API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.\
> \- AGENT-EMAIL (string): The email address of the project member whose personal document box is being\
>   opened. \*\*Required on Works projects\*\*, where it is what names the box; omitting it there is\
>   rejected rather than resolved to the project owner.\
> \- USER-EMAIL (string): The email address to associate with the user. \*\*Required on Works projects\*\*,\
>   where it is what puts the request into user scope — AGENT-EMAIL alone resolves no user.\
> \- OWN-USER-ID (string): The user ID to identify or create a user. \*\*Required on other project types\*\*,\
>   where it names the acting user. On Works it is accepted in place of USER-EMAIL.\
> \
> So a Works call sends \*\*AGENT-EMAIL and USER-EMAIL together\*\*, and any other project sends\
> \*\*OWN-USER-ID\*\*. Every endpoint acts on the resolved user's own document box; a request that\
> resolves no user is rejected — never redirected to the shared box, nor to the project owner's.<br>

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"KnowledgeBase","description":"User related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/v2/personal_folders/{folder_id}":{"delete":{"operationId":"django_server_knowledge_base_views_rest_personal_folder_api_delete_personal_folder","summary":"Delete Personal Folder","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"},{"in":"path","name":"folder_id","schema":{"title":"Folder Id","type":"string"},"required":true}],"responses":{"204":{"description":"No Content"},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication failed. The API-KEY header is missing or invalid."},"403":{"description":"Access denied. The project is inactive or the request IP is not allowed."},"500":{"description":"Internal server error."}},"description":"This API allows you to delete a folder in the requesting user's personal document box.\n\nThe folder and everything below it — subfolders and documents — are deleted. Only a folder the\ncaller owns can be deleted; a shared folder or another user's personal folder is rejected.\n\n## Headers\n\n- API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.\n- AGENT-EMAIL (string): The email address of the project member whose personal document box is being\n  opened. **Required on Works projects**, where it is what names the box; omitting it there is\n  rejected rather than resolved to the project owner.\n- USER-EMAIL (string): The email address to associate with the user. **Required on Works projects**,\n  where it is what puts the request into user scope — AGENT-EMAIL alone resolves no user.\n- OWN-USER-ID (string): The user ID to identify or create a user. **Required on other project types**,\n  where it names the acting user. On Works it is accepted in place of USER-EMAIL.\n\nSo a Works call sends **AGENT-EMAIL and USER-EMAIL together**, and any other project sends\n**OWN-USER-ID**. Every endpoint acts on the resolved user's own document box; a request that\nresolves no user is rejected — never redirected to the shared box, nor to the project owner's.\n","tags":["KnowledgeBase"]}}}}
```

## Move Personal Folder

> This API allows you to move a folder within the requesting user's personal document box.\
> \
> Both the folder being moved and the destination must belong to the caller: a personal folder cannot\
> be moved into the shared document box, and a shared folder cannot be moved into the personal one.\
> A folder cannot be moved into itself or one of its own descendants. If the destination already holds\
> a folder with the same name, the moved folder is renamed with a numeric suffix.\
> \
> The move answers 409 when the folder already sits in the destination, matching the personal document\
> move rather than reporting success for a move that did not happen.\
> \
> \## Headers\
> \
> \- API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.\
> \- AGENT-EMAIL (string): The email address of the project member whose personal document box is being\
> &#x20; opened. \*\*Required on Works projects\*\*, where it is what names the box; omitting it there is\
> &#x20; rejected rather than resolved to the project owner.\
> \- USER-EMAIL (string): The email address to associate with the user. \*\*Required on Works projects\*\*,\
> &#x20; where it is what puts the request into user scope — AGENT-EMAIL alone resolves no user.\
> \- OWN-USER-ID (string): The user ID to identify or create a user. \*\*Required on other project types\*\*,\
> &#x20; where it names the acting user. On Works it is accepted in place of USER-EMAIL.\
> \
> So a Works call sends \*\*AGENT-EMAIL and USER-EMAIL together\*\*, and any other project sends\
> \*\*OWN-USER-ID\*\*. Every endpoint acts on the resolved user's own document box; a request that\
> resolves no user is rejected — never redirected to the shared box, nor to the project owner's.\
> \
> \## Request Body\
> \
> \- parentFolderId (string, optional): The destination folder ID. Null moves the folder to the personal\
> &#x20; document box root.

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"KnowledgeBase","description":"User related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}},"schemas":{"FolderResponse":{"properties":{"id":{"title":"Id","type":"string"},"name":{"title":"Name","type":"string"},"createdAt":{"title":"Createdat","type":"number"},"updatedAt":{"title":"Updatedat","type":"number"},"parentFolderId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parentfolderid"},"folderSize":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Foldersize"}},"required":["id","name","createdAt","updatedAt"],"title":"FolderResponse","type":"object"},"MovePersonalFolderRequest":{"properties":{"parentFolderId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The destination folder ID. Null moves the folder to the personal document box root.","title":"Parentfolderid"}},"title":"MovePersonalFolderRequest","type":"object"}}},"paths":{"/webapi/v2/personal_folders/{folder_id}/move":{"post":{"operationId":"django_server_knowledge_base_views_rest_personal_folder_api_move_personal_folder","summary":"Move Personal Folder","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"},{"in":"path","name":"folder_id","schema":{"title":"Folder Id","type":"string"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FolderResponse"}}}},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication failed. The API-KEY header is missing or invalid."},"403":{"description":"Access denied. The project is inactive or the request IP is not allowed."},"500":{"description":"Internal server error."}},"description":"This API allows you to move a folder within the requesting user's personal document box.\n\nBoth the folder being moved and the destination must belong to the caller: a personal folder cannot\nbe moved into the shared document box, and a shared folder cannot be moved into the personal one.\nA folder cannot be moved into itself or one of its own descendants. If the destination already holds\na folder with the same name, the moved folder is renamed with a numeric suffix.\n\nThe move answers 409 when the folder already sits in the destination, matching the personal document\nmove rather than reporting success for a move that did not happen.\n\n## Headers\n\n- API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.\n- AGENT-EMAIL (string): The email address of the project member whose personal document box is being\n  opened. **Required on Works projects**, where it is what names the box; omitting it there is\n  rejected rather than resolved to the project owner.\n- USER-EMAIL (string): The email address to associate with the user. **Required on Works projects**,\n  where it is what puts the request into user scope — AGENT-EMAIL alone resolves no user.\n- OWN-USER-ID (string): The user ID to identify or create a user. **Required on other project types**,\n  where it names the acting user. On Works it is accepted in place of USER-EMAIL.\n\nSo a Works call sends **AGENT-EMAIL and USER-EMAIL together**, and any other project sends\n**OWN-USER-ID**. Every endpoint acts on the resolved user's own document box; a request that\nresolves no user is rejected — never redirected to the shared box, nor to the project owner's.\n\n## Request Body\n\n- parentFolderId (string, optional): The destination folder ID. Null moves the folder to the personal\n  document box root.","tags":["KnowledgeBase"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MovePersonalFolderRequest"}}},"required":true}}}}}
```

## Move Personal Document

> This API allows you to move a document within the requesting user's personal document box.\
> \
> Both the document being moved and the destination must belong to the caller: a personal document\
> cannot be moved into the shared document box, and a shared document cannot be moved into the\
> personal one. If the destination already holds a document with the same name but different content,\
> the moved document is renamed with a numeric suffix.\
> \
> The move answers 409 when the destination cannot take the document: it already sits there, or the\
> destination already holds an identical copy of it. At the personal document box root that\
> identical-copy check spans the whole project rather than the caller's own box.\
> \
> \## Headers\
> \
> \- API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.\
> \- AGENT-EMAIL (string): The email address of the project member whose personal document box is being\
> &#x20; opened. \*\*Required on Works projects\*\*, where it is what names the box; omitting it there is\
> &#x20; rejected rather than resolved to the project owner.\
> \- USER-EMAIL (string): The email address to associate with the user. \*\*Required on Works projects\*\*,\
> &#x20; where it is what puts the request into user scope — AGENT-EMAIL alone resolves no user.\
> \- OWN-USER-ID (string): The user ID to identify or create a user. \*\*Required on other project types\*\*,\
> &#x20; where it names the acting user. On Works it is accepted in place of USER-EMAIL.\
> \
> So a Works call sends \*\*AGENT-EMAIL and USER-EMAIL together\*\*, and any other project sends\
> \*\*OWN-USER-ID\*\*. Every endpoint acts on the resolved user's own document box; a request that\
> resolves no user is rejected — never redirected to the shared box, nor to the project owner's.\
> \
> \## Request Body\
> \
> \- parentFolderId (string, optional): The destination folder ID. Null moves the document to the\
> &#x20; personal document box root.

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"KnowledgeBase","description":"User related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}},"schemas":{"KnowledgeBaseNodeResponse":{"properties":{"result":{"anyOf":[{"$ref":"#/components/schemas/KnowledgeBaseNodeFolder"},{"$ref":"#/components/schemas/KnowledgeBaseNodeFile"}],"description":"Knowledge base node","title":"Result"}},"required":["result"],"title":"KnowledgeBaseNodeResponse","type":"object"},"KnowledgeBaseNodeFolder":{"properties":{"id":{"description":"knowledge base node id","title":"Id","type":"string"},"name":{"description":"knowledge base node name","title":"Name","type":"string"},"createdAt":{"description":"knowledge base node created at","title":"Createdat","type":"number"},"createdBy":{"anyOf":[{"$ref":"#/components/schemas/CreatedByAgent"},{"type":"null"}],"description":"agent who created this node"},"updatedAt":{"description":"knowledge base node updated at","title":"Updatedat","type":"number"},"nodeType":{"description":"knowledge base node type","title":"Nodetype","type":"string"},"parentFolder":{"anyOf":[{"$ref":"#/components/schemas/Folder"},{"type":"null"}],"description":"knowledge base node parent folder"},"breadcrumbs":{"description":"knowledge base node breadcrumbs","items":{"$ref":"#/components/schemas/Folder"},"title":"Breadcrumbs","type":"array"},"agentPermission":{"$ref":"#/components/schemas/AgentPermissionResponse","description":"Agent permission"},"userPermission":{"$ref":"#/components/schemas/UserPermissionResponse","description":"User permission"},"sourceType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"knowledge base folder external source type","title":"Sourcetype"}},"required":["id","name","createdAt","updatedAt","nodeType","breadcrumbs","agentPermission","userPermission"],"title":"KnowledgeBaseNodeFolder","type":"object"},"CreatedByAgent":{"properties":{"id":{"description":"agent id","title":"Id","type":"string"},"email":{"description":"agent email","title":"Email","type":"string"},"firstName":{"description":"agent first name","title":"Firstname","type":"string"},"lastName":{"description":"agent last name","title":"Lastname","type":"string"}},"required":["id","email","firstName","lastName"],"title":"CreatedByAgent","type":"object"},"Folder":{"properties":{"id":{"description":"folder id","title":"Id","type":"string"},"name":{"description":"folder name","title":"Name","type":"string"}},"required":["id","name"],"title":"Folder","type":"object"},"AgentPermissionResponse":{"description":"Response model for agent permission.","properties":{"accessAgents":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessAgent"},"type":"array"},{"type":"null"}],"description":"Agents with access to the object.","title":"Accessagents"},"accessPermissionGroups":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessPermissionGroupResponse"},"type":"array"},{"type":"null"}],"description":"Permission groups with access to the object, with names.","title":"Accesspermissiongroups"},"viewAccessToAgent":{"description":"Whether agents may view the object.","title":"Viewaccesstoagent","type":"boolean"}},"required":["viewAccessToAgent"],"title":"AgentPermissionResponse","type":"object"},"AccessAgent":{"properties":{"agentId":{"description":"エージェントID","title":"Agentid","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"アクセス方法"}},"required":["agentId","accessType"],"title":"AccessAgent","type":"object"},"ObjectAccessType":{"enum":["order_1_editor","order_2_reader"],"title":"ObjectAccessType","type":"string"},"AccessPermissionGroupResponse":{"description":"Response model for access permission group with name included.","properties":{"permissionGroupId":{"description":"The permission group ID","title":"Permissiongroupid","type":"string"},"permissionGroupName":{"description":"The permission group name","title":"Permissiongroupname","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"The access type"}},"required":["permissionGroupId","permissionGroupName","accessType"],"title":"AccessPermissionGroupResponse","type":"object"},"UserPermissionResponse":{"properties":{"ownUserIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"Customer-managed user IDs allowed by the access filters.","title":"Ownuserids"},"customerGroups":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"Customer group values allowed by the access filters.","title":"Customergroups"},"viewAccessToUser":{"description":"Whether users may view the object.","title":"Viewaccesstouser","type":"boolean"}},"required":["viewAccessToUser"],"title":"UserPermissionResponse","type":"object"},"KnowledgeBaseNodeFile":{"properties":{"id":{"description":"knowledge base node id","title":"Id","type":"string"},"name":{"description":"knowledge base node name","title":"Name","type":"string"},"createdAt":{"description":"knowledge base node created at","title":"Createdat","type":"number"},"createdBy":{"anyOf":[{"$ref":"#/components/schemas/CreatedByAgent"},{"type":"null"}],"description":"agent who created this node"},"updatedAt":{"description":"knowledge base node updated at","title":"Updatedat","type":"number"},"nodeType":{"description":"knowledge base node type","title":"Nodetype","type":"string"},"parentFolder":{"anyOf":[{"$ref":"#/components/schemas/Folder"},{"type":"null"}],"description":"knowledge base node parent folder"},"breadcrumbs":{"description":"knowledge base node breadcrumbs","items":{"$ref":"#/components/schemas/Folder"},"title":"Breadcrumbs","type":"array"},"agentPermission":{"$ref":"#/components/schemas/AgentPermissionResponse","description":"Agent permission"},"userPermission":{"$ref":"#/components/schemas/UserPermissionResponse","description":"User permission"},"piiDetected":{"default":false,"description":"Whether the document has at least one PII masking entity. False also includes documents that have not been checked for PII.","title":"Piidetected","type":"boolean"},"hashtags":{"description":"knowledge base hashtags","items":{"type":"string"},"title":"Hashtags","type":"array"},"status":{"description":"knowledge base status","title":"Status","type":"string"},"size":{"description":"knowledge base size","title":"Size","type":"integer"},"processState":{"description":"knowledge base process state","title":"Processstate","type":"string"},"properties":{"anyOf":[{"items":{"$ref":"#/components/schemas/KnowledgeBaseFileProperty"},"type":"array"},{"type":"null"}],"description":"knowledge base properties","title":"Properties"},"action":{"anyOf":[{"$ref":"#/components/schemas/KnowledgeBaseUploadAction"},{"type":"null"}],"description":"Upload result for this document: 'created', 'overwritten', 'skipped', or 'suffix_added'. Only set on upload responses."},"sourceType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"knowledge base document source type","title":"Sourcetype"}},"required":["id","name","createdAt","updatedAt","nodeType","breadcrumbs","agentPermission","userPermission","hashtags","status","size","processState"],"title":"KnowledgeBaseNodeFile","type":"object"},"KnowledgeBaseFileProperty":{"properties":{"key":{"description":"property key","title":"Key","type":"string"},"value":{"description":"property value","title":"Value","type":"string"}},"required":["key","value"],"title":"KnowledgeBaseFileProperty","type":"object"},"KnowledgeBaseUploadAction":{"enum":["created","overwritten","skipped","suffix_added"],"title":"KnowledgeBaseUploadAction","type":"string"},"MovePersonalDocumentRequest":{"properties":{"parentFolderId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The destination folder ID. Null moves the document to the personal document box root.","title":"Parentfolderid"}},"title":"MovePersonalDocumentRequest","type":"object"}}},"paths":{"/webapi/v2/personal_documents/{document_id}/move":{"post":{"operationId":"django_server_knowledge_base_views_rest_personal_document_api_move_personal_document","summary":"Move Personal Document","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"},{"in":"path","name":"document_id","schema":{"title":"Document Id","type":"string"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeBaseNodeResponse"}}}},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication failed. The API-KEY header is missing or invalid."},"403":{"description":"Access denied. The project is inactive or the request IP is not allowed."},"500":{"description":"Internal server error."}},"description":"This API allows you to move a document within the requesting user's personal document box.\n\nBoth the document being moved and the destination must belong to the caller: a personal document\ncannot be moved into the shared document box, and a shared document cannot be moved into the\npersonal one. If the destination already holds a document with the same name but different content,\nthe moved document is renamed with a numeric suffix.\n\nThe move answers 409 when the destination cannot take the document: it already sits there, or the\ndestination already holds an identical copy of it. At the personal document box root that\nidentical-copy check spans the whole project rather than the caller's own box.\n\n## Headers\n\n- API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.\n- AGENT-EMAIL (string): The email address of the project member whose personal document box is being\n  opened. **Required on Works projects**, where it is what names the box; omitting it there is\n  rejected rather than resolved to the project owner.\n- USER-EMAIL (string): The email address to associate with the user. **Required on Works projects**,\n  where it is what puts the request into user scope — AGENT-EMAIL alone resolves no user.\n- OWN-USER-ID (string): The user ID to identify or create a user. **Required on other project types**,\n  where it names the acting user. On Works it is accepted in place of USER-EMAIL.\n\nSo a Works call sends **AGENT-EMAIL and USER-EMAIL together**, and any other project sends\n**OWN-USER-ID**. Every endpoint acts on the resolved user's own document box; a request that\nresolves no user is rejected — never redirected to the shared box, nor to the project owner's.\n\n## Request Body\n\n- parentFolderId (string, optional): The destination folder ID. Null moves the document to the\n  personal document box root.","tags":["KnowledgeBase"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MovePersonalDocumentRequest"}}},"required":true}}}}}
```

## ナレッジベースの差分を取得する

> ナレッジベースの差分を取得します。

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"KnowledgeBase","description":"User related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}},"schemas":{"KnowledgeBaseDiffResponse":{"properties":{"result":{"items":{"$ref":"#/components/schemas/KnowledgeBaseDiffResponseLineDiffer"},"title":"Result","type":"array"}},"required":["result"],"title":"KnowledgeBaseDiffResponse","type":"object"},"KnowledgeBaseDiffResponseLineDiffer":{"properties":{"left":{"$ref":"#/components/schemas/KnowledgeBaseDiffResponseLineDelta"},"right":{"$ref":"#/components/schemas/KnowledgeBaseDiffResponseLineDelta"},"row":{"title":"Row","type":"integer"},"comment":{"title":"Comment","type":"string"}},"required":["left","right","row","comment"],"title":"KnowledgeBaseDiffResponseLineDiffer","type":"object"},"KnowledgeBaseDiffResponseLineDelta":{"properties":{"status":{"title":"Status","type":"string"},"page":{"title":"Page","type":"integer"},"line":{"title":"Line","type":"integer"},"text":{"title":"Text","type":"string"},"highlight":{"title":"Highlight","type":"string"}},"required":["status","page","line","text","highlight"],"title":"KnowledgeBaseDiffResponseLineDelta","type":"object"},"KnowledgeBaseDiffRequest":{"properties":{"leftId":{"description":"左のナレッジベースID","title":"Leftid","type":"string"},"rightId":{"description":"正しいナレッジベースID","title":"Rightid","type":"string"}},"required":["leftId","rightId"],"title":"KnowledgeBaseDiffRequest","type":"object"}}},"paths":{"/webapi/v2/knowledge_base_diff":{"post":{"operationId":"django_server_knowledge_base_views_rest_knowledge_base_diff_api_knowledge_base_diff","summary":"ナレッジベースの差分を取得する","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}],"responses":{"200":{"description":"正常に取得しました。","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeBaseDiffResponse"}}}},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication failed. The API-KEY header is missing or invalid."},"403":{"description":"Access denied. The project is inactive or the request IP is not allowed."},"500":{"description":"Internal server error."}},"description":"ナレッジベースの差分を取得します。","tags":["KnowledgeBase"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeBaseDiffRequest"}}},"required":true}}}}}
```

## 埋め込みステータスを取得

> プロジェクトのステータス別埋め込みページ数を返します。

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"KnowledgeBase","description":"User related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/v2/embedding_status":{"get":{"operationId":"django_server_knowledge_base_views_rest_embedding_status_api_get_embedding_status","summary":"埋め込みステータスを取得","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}],"responses":{"200":{"description":"OK"},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication failed. The API-KEY header is missing or invalid."},"403":{"description":"Access denied. The project is inactive or the request IP is not allowed."},"500":{"description":"Internal server error."}},"description":"プロジェクトのステータス別埋め込みページ数を返します。","tags":["KnowledgeBase"]}}}}
```

## 埋め込み対象ドキュメントを取得

> ナレッジベースのドキュメントを埋め込みステータス付きで、フィルターとページネーションを適用して一覧表示します。

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"KnowledgeBase","description":"User related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/v2/embedding_status/docs":{"get":{"operationId":"django_server_knowledge_base_views_rest_embedding_status_api_get_embedding_docs","summary":"埋め込み対象ドキュメントを取得","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"},{"in":"query","name":"status","schema":{"default":"","title":"Status","type":"string"},"required":false},{"in":"query","name":"page","schema":{"default":1,"title":"Page","type":"integer"},"required":false},{"in":"query","name":"search","schema":{"default":"","title":"Search","type":"string"},"required":false}],"responses":{"200":{"description":"OK"},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication failed. The API-KEY header is missing or invalid."},"403":{"description":"Access denied. The project is inactive or the request IP is not allowed."},"500":{"description":"Internal server error."}},"description":"ナレッジベースのドキュメントを埋め込みステータス付きで、フィルターとページネーションを適用して一覧表示します。","tags":["KnowledgeBase"]}}}}
```

## 埋め込みをリセット

> 解析済みページをリセットして再埋め込みします。scope='all'は全件をリセット、scope='failed'は失敗分のみ再試行します。

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"KnowledgeBase","description":"User related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}},"schemas":{"ResetScope":{"properties":{"scope":{"default":"all","title":"Scope","type":"string"}},"title":"ResetScope","type":"object"}}},"paths":{"/webapi/v2/embedding_status/reset":{"post":{"operationId":"django_server_knowledge_base_views_rest_embedding_status_api_reset_embedding","summary":"埋め込みをリセット","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}],"responses":{"200":{"description":"OK"},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication failed. The API-KEY header is missing or invalid."},"403":{"description":"Access denied. The project is inactive or the request IP is not allowed."},"500":{"description":"Internal server error."}},"description":"解析済みページをリセットして再埋め込みします。scope='all'は全件をリセット、scope='failed'は失敗分のみ再試行します。","tags":["KnowledgeBase"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResetScope"}}},"required":true}}}}}
```

## ESカウントを取得

> ナレッジベースのドキュメントがElasticsearchにインデックスされているかを確認します。

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"KnowledgeBase","description":"User related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/v2/embedding_status/{kb_id}/es-count":{"get":{"operationId":"django_server_knowledge_base_views_rest_embedding_status_api_get_es_count","summary":"ESカウントを取得","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"},{"in":"path","name":"kb_id","schema":{"title":"Kb Id","type":"string"},"required":true}],"responses":{"200":{"description":"OK"},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication failed. The API-KEY header is missing or invalid."},"403":{"description":"Access denied. The project is inactive or the request IP is not allowed."},"500":{"description":"Internal server error."}},"description":"ナレッジベースのドキュメントがElasticsearchにインデックスされているかを確認します。","tags":["KnowledgeBase"]}}}}
```

## Get Ingestion Status

> This API allows you to retrieve the document ingestion parsing pipeline status for a knowledge base.\
> \
> \## Headers\
> \
> \- API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.\
> \- AGENT-EMAIL (string, optional): The email address of the agent performing the API call.\
> \- USER-EMAIL (string, optional): The email address to associate with the user.\
> \- OWN-USER-ID (string, optional): The user ID to identify or create a user.

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"KnowledgeBase","description":"User related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}},"schemas":{"IngestionStatusResponse":{"properties":{"status":{"title":"Status","type":"string"},"startedAt":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Startedat"},"endedAt":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Endedat"},"elapsed":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Elapsed"},"steps":{"items":{"$ref":"#/components/schemas/IngestionStepResponse"},"title":"Steps","type":"array"}},"required":["status","startedAt","endedAt","elapsed","steps"],"title":"IngestionStatusResponse","type":"object"},"IngestionStepResponse":{"properties":{"name":{"title":"Name","type":"string"},"subLabel":{"title":"Sublabel","type":"string"},"startedAt":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Startedat"},"endedAt":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Endedat"},"status":{"title":"Status","type":"string"}},"required":["name","subLabel","startedAt","endedAt","status"],"title":"IngestionStepResponse","type":"object"}}},"paths":{"/webapi/v2/ingestion_status/{kb_id}":{"get":{"operationId":"django_server_knowledge_base_views_rest_ingestion_status_api_get_ingestion_status","summary":"Get Ingestion Status","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"},{"in":"path","name":"kb_id","schema":{"title":"Kb Id","type":"string"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IngestionStatusResponse"}}}},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication failed. The API-KEY header is missing or invalid."},"403":{"description":"Access denied. The project is inactive or the request IP is not allowed."},"500":{"description":"Internal server error."}},"description":"This API allows you to retrieve the document ingestion parsing pipeline status for a knowledge base.\n\n## Headers\n\n- API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.\n- AGENT-EMAIL (string, optional): The email address of the agent performing the API call.\n- USER-EMAIL (string, optional): The email address to associate with the user.\n- OWN-USER-ID (string, optional): The user ID to identify or create a user.","tags":["KnowledgeBase"]}}}}
```

## GET /download\_document\_by\_name/{project\_id}

> ファイル名でドキュメントをダウンロード

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"KnowledgeBase","description":"User related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/download_document_by_name/{project_id}":{"get":{"tags":["KnowledgeBase"],"operationId":"downloadDocumentByName","summary":"ファイル名でドキュメントをダウンロード","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"filename":{"type":"string","description":"ダウンロードするドキュメント名"}}}}}},"responses":{"200":{"description":"ドキュメントファイルが正常にダウンロードされました。","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"複数のドキュメントが見つかりました。"},"401":{"description":"無許可"},"403":{"description":"禁止された"},"404":{"description":"ドキュメントが見つかりませんでした。"},"500":{"description":"内部サーバーエラー"}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"},{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}}]}}}}
```

## 単一のドキュメントを取得

> これは、単一のドキュメントの詳細を取得する方法です。

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"KnowledgeBase","description":"User related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/single_document":{"get":{"tags":["KnowledgeBase"],"operationId":"getExactDocument","summary":"単一のドキュメントを取得","description":"これは、単一のドキュメントの詳細を取得する方法です。","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"},{"name":"id","in":"query","required":true,"schema":{"type":"string"},"description":"ドキュメントのID。"}],"responses":{"200":{"description":"ドキュメントの詳細を正常に取得しました。","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"id":{"type":"string","description":"ドキュメントのID。"},"documentName":{"type":"string","description":"ドキュメントのファイル名。"},"createdDate":{"type":"string","format":"date","description":"ドキュメントがアップロードされた日付。"},"hashtags":{"type":"array","items":{"type":"string"},"description":"ドキュメントのために登録されたハッシュタグ。"},"agentFeedback":{"type":"object","properties":{"positiveCount":{"type":"integer","description":"メンバーからの肯定的なフィードバックの数。"},"negativeCount":{"type":"integer","description":"メンバーからの否定的なフィードバックの数。"}},"description":"ユーザーによる肯定的および否定的評価の数。"},"userFeedback":{"type":"object","properties":{"positiveCount":{"type":"integer","description":"ユーザーからの肯定的なフィードバックの数。"},"negativeCount":{"type":"integer","description":"ユーザーからの否定的なフィードバックの数。"}},"description":"ドキュメントに対するユーザーからのフィードバック。"}}}}}}}},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication failed. The API-KEY header is missing or invalid."},"403":{"description":"Access denied. The project is inactive or the request IP is not allowed."},"500":{"description":"Internal server error."}}}}}}
```

## ドキュメントをアップロード

> このAPIを使用して、ドキュメントメニューにドキュメントをアップロードすることが可能です。 アップロード可能なファイル形式は、下記になります。\
> ファイル形式：.txt, .docx, .csv, .xls, .xlsx, .jpg, .jpeg, .png, .hwp, .hwpx, .pdf, .ppt, .pptx, .doc\
> 外部リンクが含まれるHTMLファイルをアップロードするには、アップロードする前に関連するリンク先のHTMLも含め、zipファイルに圧縮の上、アップロードしてください。<br>

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"KnowledgeBase","description":"User related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/upload_file":{"post":{"tags":["KnowledgeBase"],"operationId":"uploadFile","summary":"ドキュメントをアップロード","description":"このAPIを使用して、ドキュメントメニューにドキュメントをアップロードすることが可能です。 アップロード可能なファイル形式は、下記になります。\nファイル形式：.txt, .docx, .csv, .xls, .xlsx, .jpg, .jpeg, .png, .hwp, .hwpx, .pdf, .ppt, .pptx, .doc\n外部リンクが含まれるHTMLファイルをアップロードするには、アップロードする前に関連するリンク先のHTMLも含め、zipファイルに圧縮の上、アップロードしてください。\n","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"ローカルファイルの場所"},"hashtags":{"type":"array","description":"アップロードファイルのためのハッシュタグ","items":{"type":"string"}},"footerTitle":{"type":"string","description":"アップロードされたファイルからの検索結果のフッターとして答えの情報源を入力できます。フッターテキストは検索結果の『From』の隣に表示されます。"},"footerUrl":{"type":"string","description":"リンクしたいURLをfooterTitleに入れることができます。"},"parentFolderId":{"type":"string","description":"アップロードする対象フォルダID。最上位レベルに挿入するにはヌル。"},"allowOtherAgentsView":{"type":"boolean","description":"このドキュメントを他のエージェントが閲覧できるようにするかどうか"},"allowOtherUsersView":{"type":"boolean","description":"他のユーザーがこのドキュメントを閲覧することを許可するかどうか"},"useLayout":{"type":"boolean","description":"ドキュメントの解析処理を向上させるためにレイアウト処理を使用するかどうかを指定します。プロジェクトでこの機能が許可されている場合にのみ使用されます。 機能の有効化が必要な場合は担当のカスタマーサクセスまでお問い合わせください。"},"useImageDescription":{"type":"boolean","description":"ドキュメントの解析処理を向上させるためにimage description処理を使用するかどうかを指定します。プロジェクトでこの機能が許可されている場合にのみ使用されます。 機能の有効化が必要な場合は担当のカスタマーサクセスまでお問い合わせください。"},"properties":{"type":"object","description":"ドキュメントに付与するメタデータ情報","additionalProperties":{"type":"string"}}}}}}},"responses":{"200":{"description":"ファイルのアップロードが成功しました。","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"id":{"type":"string","description":"アップロードされたドキュメントのID"},"file_name":{"type":"string","description":"アップロードされたドキュメントのファイル名"},"hashtags":{"type":"array","description":"アップロードされたドキュメントに追加されたハッシュタグの配列","items":{"type":"string"}},"footer":{"type":"string","description":"アップロードされたドキュメントに追加されたフッター（出典）情報"}}}}}}}},"400":{"description":"無効なリクエストまたはファイル形式"},"401":{"description":"Authentication failed. The API-KEY header is missing or invalid."},"403":{"description":"Access denied. The project is inactive or the request IP is not allowed."},"413":{"description":"ファイルサイズが制限を超えています。"},"500":{"description":"Internal server error."}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}]}}}}
```

## S3からドキュメントをアップロードする

> このAPIを使用すると、S3に保存されているドキュメントをAlliのドキュメントメニューに転送できます。利用可能なファイル形式は、アップロードドキュメントセクションと同じです。

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"KnowledgeBase","description":"User related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/upload_from_s3":{"post":{"tags":["KnowledgeBase"],"operationId":"uploadFromS3","summary":"S3からドキュメントをアップロードする","description":"このAPIを使用すると、S3に保存されているドキュメントをAlliのドキュメントメニューに転送できます。利用可能なファイル形式は、アップロードドキュメントセクションと同じです。","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"path":{"type":"string","description":"ファイルのS3パス。ファイル名で終わる必要があります。バケット名を含めないでください。"},"secretKey":{"type":"string","description":"あなたのS3シークレットキー。"},"accessKey":{"type":"string","description":"あなたのS3アクセスキー。"},"bucket":{"type":"string","description":"ファイルを含むS3バケットの名前。"},"footerTitle":{"type":"string","description":"検索結果でのフッターテキストとして回答の出典を入力できます。フッターテキストは、検索結果の「出典」の横に表示されます。"},"footerUrl":{"type":"string","description":"リンクしたいURLをfooterTitleに入れることができます。"},"hashtags":{"type":"array","description":"ドキュメントのハッシュタグ。","items":{"type":"string"}},"parentFolderId":{"type":"string","description":"アップロード先のターゲットフォルダーID。最上位に挿入する場合は空にして下さい。"},"properties":{"type":"object","description":"ドキュメントに付与できるメタ情報です。","additionalProperties":{"type":"string"}}}}}}},"responses":{"200":{"description":"S3からファイルが正常にアップロードされました。","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"id":{"type":"string","description":"転送されたドキュメントのID。"},"file_name":{"type":"string","description":"転送された文書のファイル名。"},"hashtags":{"type":"array","description":"アップロードされたドキュメントに追加されたハッシュタグの配列。","items":{"type":"string"}},"footer":{"type":"string","description":"アップロードされた文書にフッター（ソース）情報が追加されました。"}}}}}}}},"400":{"description":"無効なリクエストパラメーター"},"401":{"description":"Authentication failed. The API-KEY header is missing or invalid."},"403":{"description":"Access denied. The project is inactive or the request IP is not allowed."},"404":{"description":"S3でファイルが見つかりません。"},"500":{"description":"Internal server error."}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}]}}}}
```

## ドキュメントのステータスを確認

> APIを介してドキュメントをアップロードすると、変換、解析され、ベクトルとして埋め込まれます。このAPIは、アップロードされるドキュメントの処理状況を表示します。

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"KnowledgeBase","description":"User related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/check_file_status":{"get":{"tags":["KnowledgeBase"],"operationId":"checkFileStatus","summary":"ドキュメントのステータスを確認","description":"APIを介してドキュメントをアップロードすると、変換、解析され、ベクトルとして埋め込まれます。このAPIは、アップロードされるドキュメントの処理状況を表示します。","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"},{"name":"id","in":"query","required":true,"schema":{"type":"string"},"description":"ステータスを確認するためのドキュメントID"}],"responses":{"200":{"description":"ファイルのステータスを正常に取得しました。","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"id":{"type":"string","description":"確認中のドキュメントのID"},"status":{"type":"string","description":"ドキュメントのステータス（例：初期化中、処理中、完了、失敗）"},"errorName":{"type":"string","description":"ステータスが失敗を示している場合のエラー名"}}}}}}}},"400":{"description":"無効なタスクIDまたはファイルが見つかりません"},"401":{"description":"Authentication failed. The API-KEY header is missing or invalid."},"403":{"description":"Access denied. The project is inactive or the request IP is not allowed."},"500":{"description":"Internal server error."}}}}}}
```

## ドキュメントの名前を変更 (ナレッジベース)

> このAPIを使用すると、ドキュメントメニューにアップロードされたドキュメントの名前を更新できます。

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"KnowledgeBase","description":"User related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/update_kb_name":{"post":{"tags":["KnowledgeBase"],"operationId":"updateKnowledgeBaseName","summary":"ドキュメントの名前を変更 (ナレッジベース)","description":"このAPIを使用すると、ドキュメントメニューにアップロードされたドキュメントの名前を更新できます。","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"変更したいファイルのID。"},"filename":{"type":"string","description":"指定したファイルの新しい名前を入力。"}}}}}},"responses":{"200":{"description":"ファイルの名前が正常に更新されました。","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"id":{"type":"string","description":"ファイル名が変更されたファイルのID。"},"filename":{"type":"string","description":"ファイルの新しい名前。"}}}}}}}},"400":{"description":"無効なパラメータ"},"401":{"description":"Authentication failed. The API-KEY header is missing or invalid."},"403":{"description":"Access denied. The project is inactive or the request IP is not allowed."},"500":{"description":"Internal server error."}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}]}}}}
```

## Replace Document File

> This API allows you to replace the file of an existing document while keeping its metadata (hashtags, permissions, etc.).\
> \
> \## Headers\
> \
> \- API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.\
> \- AGENT-EMAIL (string, optional): The email address of the agent performing the API call.\
> \- USER-EMAIL (string, optional): The email address to associate with the user.\
> \- OWN-USER-ID (string, optional): The user ID to identify or create a user.\
> \
> \## Request Body (multipart/form-data)\
> \
> \- id (string, required): The ID of the document whose file you want to replace.\
> \- file (binary, required): The new file to upload.\
> \- resetClueFeedbacks (boolean, optional): Whether to reset answer feedbacks for this document. Defaults to \*\*false\*\*.<br>

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"KnowledgeBase","description":"User related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/replace_file":{"post":{"tags":["KnowledgeBase"],"operationId":"replaceFile","summary":"Replace Document File","description":"This API allows you to replace the file of an existing document while keeping its metadata (hashtags, permissions, etc.).\n\n## Headers\n\n- API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.\n- AGENT-EMAIL (string, optional): The email address of the agent performing the API call.\n- USER-EMAIL (string, optional): The email address to associate with the user.\n- OWN-USER-ID (string, optional): The user ID to identify or create a user.\n\n## Request Body (multipart/form-data)\n\n- id (string, required): The ID of the document whose file you want to replace.\n- file (binary, required): The new file to upload.\n- resetClueFeedbacks (boolean, optional): Whether to reset answer feedbacks for this document. Defaults to **false**.\n","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"id":{"type":"string"},"file":{"type":"string","format":"binary"},"resetClueFeedbacks":{"type":"boolean"}}}}}},"responses":{"200":{"description":"File replaced successfully","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"id":{"type":"string"},"file_name":{"type":"string"}}}}}}}},"400":{"description":"Invalid parameters"},"401":{"description":"Authentication failed. The API-KEY header is missing or invalid."},"403":{"description":"Access denied. The project is inactive or the request IP is not allowed."},"500":{"description":"Internal server error."}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}]}}}}
```

## タイトルでドキュメントを検索

> このAPIでは、ドキュメント名でドキュメントを検索することができます。

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"KnowledgeBase","description":"User related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/search_document_by_title":{"get":{"tags":["KnowledgeBase"],"operationId":"searchDocumentByTitle","summary":"タイトルでドキュメントを検索","description":"このAPIでは、ドキュメント名でドキュメントを検索することができます。","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"},{"name":"query","in":"query","required":true,"schema":{"type":"string"},"description":"ドキュメントタイトルの検索用語。"},{"name":"hashtags","in":"query","required":false,"schema":{"type":"string"},"description":"ドキュメントをフィルターするためのカンマ区切りのハッシュタグのリスト。"},{"name":"combinedHashtags","in":"query","required":false,"schema":{"type":"string"},"description":"グループをセミコロンで区切り、グループ内のタグをカンマで区切る複雑なハッシュタグフィルタリング(例:\"a,b;c,d\")。"},{"name":"excludingHashtags","in":"query","required":false,"schema":{"type":"string"},"description":"ドキュメントを除外するためのカンマ区切りのハッシュタグのリスト。"},{"name":"useVector","in":"query","required":false,"schema":{"type":"string"},"description":"セマンティックマッチングにベクトル検索を使用するには「true」、テキストベースの検索には「false」に設定します。"},{"name":"sortKey","in":"query","required":false,"schema":{"type":"string"},"description":"結果を並べ替えるプロパティフィールド。"},{"name":"sortDirection","in":"query","required":false,"schema":{"type":"string","enum":["asc","desc"]},"description":"結果をソートする方向(昇順または降順)。"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer"},"description":"ページネーションのためにスキップする結果の数。"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer"},"description":"返す結果の最大数。"}],"responses":{"200":{"description":"検索に成功しました","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ドキュメントのID。"},"file_name":{"type":"string","description":"ドキュメント名。"},"page_count":{"type":"integer","description":"ドキュメントのページ数。"},"download_url":{"type":"string","description":"ドキュメントをダウンロードするためのURL。"},"hashtags":{"type":"array","items":{"type":"string"},"description":"ドキュメントに関連するハッシュタグ。"},"score":{"type":"number","description":"検索クエリの関連性スコア。"},"folder":{"type":"string","description":"ドキュメントを含むフォルダー。"},"agentEditor":{"type":"array","items":{"type":"string"},"description":"編集権限を持つエージェントのリスト。"},"agentViewer":{"type":"array","items":{"type":"string"},"description":"閲覧権限を持つ担当者のリスト。"}}}}}}}}},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication failed. The API-KEY header is missing or invalid."},"403":{"description":"Access denied. The project is inactive or the request IP is not allowed."},"500":{"description":"Internal server error."}}}}}}
```

## POST /run\_table\_to\_description\_by\_kb

> Generate description for a table from a knowledge base file

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"KnowledgeBase","description":"User related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/run_table_to_description_by_kb":{"post":{"tags":["KnowledgeBase"],"operationId":"runTableToDescriptionByKB","summary":"Generate description for a table from a knowledge base file","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"api_key":{"type":"string"},"project_id":{"type":"string"},"knowledge_base_id":{"type":"string"},"driver":{"type":"string"},"language":{"type":"string"}}}}}},"responses":{"200":{"description":"Successfully generated table descriptions (one per sheet)","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"sheet_name":{"type":"string"},"table_description":{"type":"string"},"table_range":{"type":"string"},"header_info":{"type":"array","items":{"type":"object","properties":{"cell_no":{"type":"string"},"column_name":{"type":"string"},"column_description":{"type":"string"},"column_type":{"type":"string"}}}}}}}}}},"400":{"description":"Invalid request parameters."},"401":{"description":"Invalid API key"},"403":{"description":"Access denied. The project is inactive or the request IP is not allowed."},"404":{"description":"Knowledge base not found or has no file"},"500":{"description":"Internal server error."}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}]}}}}
```

## Rerun Document Ingestion

> This API allows you to re-trigger the document ingestion pipeline for specific knowledge base documents.\
> \
> \## Headers\
> \
> \- API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.\
> \- AGENT-EMAIL (string, optional): The email address of the agent performing the API call.\
> \- USER-EMAIL (string, optional): The email address to associate with the user.\
> \- OWN-USER-ID (string, optional): The user ID to identify or create a user.\
> \
> \## Request Body\
> \
> \- knowledge\_base\_ids (array\[string], required): List of knowledge base document IDs to re-ingest.<br>

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"KnowledgeBase","description":"User related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/document_ingestion/rerun":{"post":{"tags":["KnowledgeBase"],"operationId":"ingestKnowledgeBase","summary":"Rerun Document Ingestion","description":"This API allows you to re-trigger the document ingestion pipeline for specific knowledge base documents.\n\n## Headers\n\n- API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.\n- AGENT-EMAIL (string, optional): The email address of the agent performing the API call.\n- USER-EMAIL (string, optional): The email address to associate with the user.\n- OWN-USER-ID (string, optional): The user ID to identify or create a user.\n\n## Request Body\n\n- knowledge_base_ids (array[string], required): List of knowledge base document IDs to re-ingest.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"knowledge_base_ids":{"type":"array","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"Successfully ingested knowledge base","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"integer"}}}}}},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication failed. The API-KEY header is missing or invalid."},"403":{"description":"Access denied. The project is inactive or the request IP is not allowed."},"500":{"description":"Internal server error."}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}]}}}}
```

## Rerun All Document Ingestion

> This API allows you to re-trigger the document ingestion pipeline for all knowledge base documents in the project.\
> \
> \## Headers\
> \
> \- API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.\
> \- AGENT-EMAIL (string, optional): The email address of the agent performing the API call.\
> \- USER-EMAIL (string, optional): The email address to associate with the user.\
> \- OWN-USER-ID (string, optional): The user ID to identify or create a user.<br>

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"KnowledgeBase","description":"User related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/document_ingestion/rerun_all":{"post":{"tags":["KnowledgeBase"],"operationId":"ingestKnowledgeBaseAll","summary":"Rerun All Document Ingestion","description":"This API allows you to re-trigger the document ingestion pipeline for all knowledge base documents in the project.\n\n## Headers\n\n- API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.\n- AGENT-EMAIL (string, optional): The email address of the agent performing the API call.\n- USER-EMAIL (string, optional): The email address to associate with the user.\n- OWN-USER-ID (string, optional): The user ID to identify or create a user.\n","responses":{"200":{"description":"Successfully ingested all knowledge bases","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"integer"}}}}}},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication failed. The API-KEY header is missing or invalid."},"403":{"description":"Access denied. The project is inactive or the request IP is not allowed."},"500":{"description":"Internal server error."}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}]}}}}
```

## List Parsing Failed Documents

> This API allows you to retrieve a list of knowledge base documents that failed during the parsing stage of document ingestion.\
> \
> \## Headers\
> \
> \- API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.\
> \- AGENT-EMAIL (string, optional): The email address of the agent performing the API call.\
> \- USER-EMAIL (string, optional): The email address to associate with the user.\
> \- OWN-USER-ID (string, optional): The user ID to identify or create a user.<br>

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"KnowledgeBase","description":"User related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/document_ingestion/failed":{"get":{"tags":["KnowledgeBase"],"operationId":"listParsingFailedKnowledgeBases","summary":"List Parsing Failed Documents","description":"This API allows you to retrieve a list of knowledge base documents that failed during the parsing stage of document ingestion.\n\n## Headers\n\n- API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.\n- AGENT-EMAIL (string, optional): The email address of the agent performing the API call.\n- USER-EMAIL (string, optional): The email address to associate with the user.\n- OWN-USER-ID (string, optional): The user ID to identify or create a user.\n","responses":{"200":{"description":"Successfully listed failed knowledge bases","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"file_name":{"type":"string"},"state":{"type":"string"}}}}}}}}},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication failed. The API-KEY header is missing or invalid."},"403":{"description":"Access denied. The project is inactive or the request IP is not allowed."},"500":{"description":"Internal server error."}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}]}}}}
```

## Get Document Previews

> This API allows you to retrieve previews for knowledge base documents, including HTML body and PDF page information.\
> \
> \## Headers\
> \
> \- API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.\
> \- AGENT-EMAIL (string, optional): The email address of the agent performing the API call.\
> \- USER-EMAIL (string, optional): The email address to associate with the user.\
> \- OWN-USER-ID (string, optional): The user ID to identify or create a user.\
> \
> \## Request Body\
> \
> \- inputs (array\[object], required): List of preview input objects specifying which documents and pages to preview.<br>

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"KnowledgeBase","description":"User related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/previews":{"post":{"tags":["KnowledgeBase"],"operationId":"getPreviews","summary":"Get Document Previews","description":"This API allows you to retrieve previews for knowledge base documents, including HTML body and PDF page information.\n\n## Headers\n\n- API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.\n- AGENT-EMAIL (string, optional): The email address of the agent performing the API call.\n- USER-EMAIL (string, optional): The email address to associate with the user.\n- OWN-USER-ID (string, optional): The user ID to identify or create a user.\n\n## Request Body\n\n- inputs (array[object], required): List of preview input objects specifying which documents and pages to preview.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"inputs":{"type":"array","items":{"type":"object"}}}}}}},"responses":{"200":{"description":"Successfully retrieved previews","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object"}}}}}}},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication failed. The API-KEY header is missing or invalid."},"403":{"description":"Access denied. The project is inactive or the request IP is not allowed."},"500":{"description":"Internal server error."}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}]}}}}
```

## ドキュメントを削除

> このAPIを使用すると、アップロードされたドキュメントを削除できます。

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"KnowledgeBase","description":"User related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/delete_file":{"post":{"tags":["KnowledgeBase"],"operationId":"deleteFile","summary":"ドキュメントを削除","description":"このAPIを使用すると、アップロードされたドキュメントを削除できます。","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"type":"array","description":"配列形式で削除したいドキュメントIDを指定します。","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"ドキュメントが正常に削除されました。","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"ok":{"type":"boolean","description":"削除が正常に完了した場合はTrue"}}},"errors":{"type":"object","nullable":true,"description":"削除が失敗した場合、ここにエラーメッセージが表示されます。"}}}}}},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication failed. The API-KEY header is missing or invalid."},"403":{"description":"Access denied. The project is inactive or the request IP is not allowed."},"500":{"description":"Internal server error."}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}]}}}}
```

## ドキュメントリストを取得

> アップロードされているドキュメントをリスト形式で取得します

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"KnowledgeBase","description":"User related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/knowledge_bases":{"get":{"tags":["KnowledgeBase"],"operationId":"knowledgeBases","summary":"ドキュメントリストを取得","description":"アップロードされているドキュメントをリスト形式で取得します","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"},{"name":"hashtagsSearchOperator","in":"query","required":false,"schema":{"type":"string","enum":["AND","OR"],"default":"OR"},"description":"複数のハッシュタグを照合するために使用される論理演算子。AND または OR のいずれかを指定できます。デフォルトは OR です。"},{"name":"status","in":"query","required":false,"schema":{"type":"boolean"},"description":"リストをフィルタリングする対象ドキュメントのON/OFF状態"},{"name":"searchTerm","in":"query","required":false,"schema":{"type":"string"},"description":"リストを絞り込むためのキーワード検索クエリ。演算子を使用して高度な検索を実行できます。 AND検索には「TERM1 TERM2」、OR検索には「TERM1 OR TERM2」、完全一致検索には「TERM\\」を使用します。"},{"name":"hashtags","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}},"description":"リストをフィルタリングするためのハッシュタグ情報。"},{"name":"order","in":"query","required":false,"schema":{"type":"string","enum":["FILE_NAME_ASC","FILE_NAME_DESC","TYPE_ASC","TYPE_DESC","STATUS_ASC","STATUS_DESC","CREATED_AT_ASC","CREATED_AT_DESC"]},"description":"リストの並べ替え順。ファイル名にはFILE_NAME_ASC/DESC、ファイルタイプにはTYPE_ASC/DESC、オン/オフ状態にはSTATUS_ASC/DESC、アップロード日時にはCREATED_AT_ASC/DESCを使用します。"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0},"description":"オフセットを使用すると、ページ上の最初の項目の順位番号を指定できます。"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100},"description":"limit を使用すると、1ページに表示されるオブジェクト数を設定できます。 最大値は100です。"}],"responses":{"200":{"description":"ドキュメントリストの取得に成功","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the listed document."},"fileName":{"type":"string","description":"The filename of the list document."},"hashtags":{"type":"array","items":{"type":"string"},"description":"The hashtags added on the document."},"autoHashtags":{"type":"array","items":{"type":"object"},"description":"The automatically generated hashtags added to the document."},"folder":{"type":"string","description":"The folder where the document is located."},"agentEditor":{"type":"array","items":{"type":"string"},"description":"List of agent emails with editor permissions."},"agentViewer":{"type":"array","items":{"type":"string"},"description":"List of agent emails with viewer permissions."},"userViewer":{"type":"object","properties":{"variables":{"type":"object"}},"description":"User viewer configuration with variables."},"allowOtherAgentsView":{"type":"boolean","description":"Whether other agents can view this document."},"allowOtherUsersView":{"type":"boolean","description":"Whether other users can view this document."}}}}}},"errors":{"type":"object","nullable":true,"description":"リクエスト処理が失敗した際のエラー情報を格納する"}}}}}},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication failed. The API-KEY header is missing or invalid."},"403":{"description":"Access denied. The project is inactive or the request IP is not allowed."},"500":{"description":"Internal server error."}}}}}}
```

## ドキュメントのプレビューを確認

> アップロードされたドキュメントのプレビューを確認できます。

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"KnowledgeBase","description":"User related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/knowledge_base_preview":{"get":{"tags":["KnowledgeBase"],"operationId":"knowledgeBasePreview","summary":"ドキュメントのプレビューを確認","description":"アップロードされたドキュメントのプレビューを確認できます。","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"},{"name":"id","in":"query","required":true,"schema":{"type":"string"},"description":"プレビューを行うドキュメントID"},{"name":"pageNo","in":"query","required":true,"schema":{"type":"string"},"description":"プレビューを行うドキュメントのページ"}],"responses":{"200":{"description":"ドキュメントプレビューの取得に成功","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"totalPageCount":{"type":"integer","description":"ドキュメントの総ページ数"},"pageNo":{"type":"integer","description":"現在プレビュー中のページ番号"},"css":{"type":"string","nullable":true,"description":"ドキュメントのCSSスタイル設定"},"body":{"type":"string","nullable":true,"description":"ドキュメントのHTML本文コンテンツ"},"highlightIndexes":{"type":"array","items":{"type":"integer"},"description":"ハイライトインデックスの配列"},"exactAnswer":{"type":"string","nullable":true,"description":"正解の回答（回答がある場合）"},"pdf":{"type":"string","nullable":true,"description":"PDFコンテンツまたは「PDF」文字列。ページ番号が無効などのエラーが発生した場合、nullを返します"},"draftjs":{"type":"string","nullable":true,"description":"ドラフトJS形式のコンテンツ"},"highlights":{"type":"object","properties":{"indexes":{"type":"array","nullable":true,"items":{"type":"integer"},"description":"ハイライトインデックス"},"pageIndexes":{"type":"array","items":{"type":"integer"},"description":"ページ固有のハイライトインデックス"},"__typename":{"type":"string","description":"GraphQLのタイプ名"}},"description":"ドキュメントのハイライト情報"},"knowledgeBase":{"type":"object","properties":{"id":{"type":"string","description":"ドキュメントのID"},"title":{"type":"string","description":"ドキュメントのタイトル"},"__typename":{"type":"string","description":"GraphQLのタイプ名"}},"description":"ナレッジベース情報"},"__typename":{"type":"string","description":"GraphQLのタイプ名"}}},"errors":{"type":"object","nullable":true,"description":"リクエストが失敗した場合のエラー情報"}}}}}},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication failed. The API-KEY header is missing or invalid."},"403":{"description":"Access denied. The project is inactive or the request IP is not allowed."},"500":{"description":"Internal server error."}}}}}}
```

## ドキュメント情報の更新

> このAPIでは、ドキュメントのハッシュタグ・フッタータイトル・フッターリンクを更新できます。

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"KnowledgeBase","description":"User related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/update_document":{"post":{"tags":["KnowledgeBase"],"operationId":"updateDocument","summary":"ドキュメント情報の更新","description":"このAPIでは、ドキュメントのハッシュタグ・フッタータイトル・フッターリンクを更新できます。","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"更新したいドキュメントのID"},"footerTitle":{"type":"string","description":"アップロードしたファイルから生成された検索結果に出典(ソース)として表示されるフッターテキストを設定できます。検索結果の「From」の右側に表示されます。"},"footerUrl":{"type":"string","description":"footerTitleにリンクさせたいURLを指定します。"},"folder":{"type":"string","description":"ドキュメントをアップロードするときの保存先フォルダーを指定します。"},"followFolderPermission":{"type":"boolean","description":"フォルダの権限設定を引き継ぐかどうかを指定します。"},"agentsEditor":{"type":"array","items":{"type":"string"},"description":"このドキュメントに対して編集権限を持つメンバーを指定します。"},"agentsViewer":{"type":"array","items":{"type":"string"},"description":"このファイルに対して閲覧権限を持つメンバーを指定します。"},"userViewer":{"type":"object","description":"このドキュメントを閲覧する権限を持つユーザーを指定します。","properties":{"customer_id":{"type":"array","items":{"type":"string"}},"customer_group":{"type":"array","items":{"type":"string"}}}},"allowOtherAgentsView":{"type":"boolean","description":"閲覧者や編集者に指定されていないメンバーにも、このドキュメントの閲覧を許可するかどうかを指定します。"},"allowOtherUsersView":{"type":"boolean","description":"閲覧者や編集者として指定されていない一般ユーザーにも、このドキュメントの閲覧を許可するかどうかを指定します。"},"hashtags":{"type":"array","items":{"type":"string"},"description":"ドキュメントに追加したいハッシュタグ(文字列)の一覧です。"},"properties":{"type":"object","description":"ドキュメントに紐づける任意のプロパティ(属性)を設定します。","additionalProperties":{"type":"string"}}}}}}},"responses":{"200":{"description":"ドキュメントが正常に更新されました。","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"knowledgeBase":{"type":"object","properties":{"id":{"type":"string","description":"ハッシュタグ付与の更新がされたドキュメントのIDを示します。"},"hashtags":{"type":"array","items":{"type":"string"},"description":"更新後にドキュメントへ付与されたハッシュタグ。"},"footer":{"type":"string","description":"アップロードされたドキュメントに追加されるフッター(出典)情報です。デフォルトのフッターか、footerTitle および footerUrl で指定した内容が反映されます。※HTML 形式で返されます。"}}}}},"errors":{"type":"object","nullable":true,"description":"リクエストが失敗した場合のエラー情報です。"}}}}}},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication failed. The API-KEY header is missing or invalid."},"403":{"description":"Access denied. The project is inactive or the request IP is not allowed."},"500":{"description":"Internal server error."}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}]}}}}
```

## ナレッジベースのステータス変更

> このAPIでは、ナレッジベースの複数のドキュメントの\
> 公開・非公開(ON/OFF)ステータスをまとめて変更できます。<br>

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"KnowledgeBase","description":"User related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/toggle_documents":{"post":{"tags":["KnowledgeBase"],"operationId":"toggleDocuments","summary":"ナレッジベースのステータス変更","description":"このAPIでは、ナレッジベースの複数のドキュメントの\n公開・非公開(ON/OFF)ステータスをまとめて変更できます。\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["use","ids"],"properties":{"use":{"type":"boolean","description":"全ての指定ドキュメントのステータスをON(true) にするか、OFF(false) にするかを指定します。true → すべて「ON」、false → すべて「OFF」"},"ids":{"type":"array","items":{"type":"string"},"description":"ステータスを切り替えたいドキュメントIDのリスト。"}}}}}},"responses":{"200":{"description":"ナレッジベースのステータスが正常に切り替えられました。","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"knowledgeBases":{"type":"array","description":"ステータスが切り替えられたドキュメントの一覧。","items":{"type":"object","properties":{"id":{"type":"string","description":"ドキュメントのID"},"status":{"type":"boolean","description":"ドキュメントの新しいステータス。true の場合はステータスが ON になっていることを意味します。"}}}}}},"errors":{"type":"object","nullable":true,"description":"リクエストが失敗した場合のエラー情報。"}}}}}},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication failed. The API-KEY header is missing or invalid."},"403":{"description":"Access denied. The project is inactive or the request IP is not allowed."},"500":{"description":"Internal server error."}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}]}}}}
```