KnowledgeBase

Knowledge base, folder, and node related APIs

Move Knowledge Base Nodes

post

https://backend.alli.aihttps://backend-ja.alli.ai

/webapi/v2/knowledge_base_nodes/move/bulk

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body

application/json

targetFolderIdany ofRequired

The target folder ID of the knowledge base node

stringOptional

or

nullOptional

nodeIdsstring[]Required

The node IDs of the knowledge base node

keepCurrentPermissionbooleanRequired

The keep current permission of the knowledge base node

Responses

200

OK

application/json

moved_kb_node_idsstring[]Required

Moved knowledge base node IDs

failed_kb_node_idsstring[]Required

Failed knowledge base node IDs

post

/webapi/v2/knowledge_base_nodes/move/bulk

HTTPcURLJavaScriptPython

POST /webapi/v2/knowledge_base_nodes/move/bulk HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "targetFolderId": "text",
  "nodeIds": [
    "text"
  ],
  "keepCurrentPermission": true
}

200

OK

{
  "moved_kb_node_ids": [
    "text"
  ],
  "failed_kb_node_ids": [
    "text"
  ]
}

Upload Knowledge Base Node

post

https://backend.alli.aihttps://backend-ja.alli.ai

/webapi/v2/knowledge_base_nodes/upload

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body

multipart/form-data

fileNamestringRequired

The file name of the knowledge base

hashtagsany ofOptional

The hashtags of the knowledge base

string[]Optional

or

nullOptional

targetFolderIdany ofOptional

The target folder ID of the knowledge base

stringOptional

or

nullOptional

isOverwriteFolderAccessany ofOptional

The overwrite folder access flag of the knowledge base

Default: false

booleanOptional

or

nullOptional

accessPermissionGroupsany ofOptional

The access permission groups of the knowledge base

or

nullOptional

accessAgentsany ofOptional

The access agents of the knowledge base

or

nullOptional

accessUserFiltersany ofOptional

The access user filters of the knowledge base

or

nullOptional

viewAccessToAgentany ofOptional

The view access to agent flag of the knowledge base

Default: false

booleanOptional

or

nullOptional

viewAccessToUserany ofOptional

The view access to user flag of the knowledge base

Default: false

booleanOptional

or

nullOptional

useLayoutany ofOptional

Whether to use layout processing for improved document ingestion. Only used if project allows this feature.

Default: true

booleanOptional

or

nullOptional

useImageDescriptionany ofOptional

Whether to use image description for improved document ingestion. Only used if project allows this feature.

Default: true

booleanOptional

or

nullOptional

useOcrany ofOptional

Whether to use OCR for document processing

Default: false

booleanOptional

or

nullOptional

notificationHooksany ofOptional

List of notification hooks to trigger on document ingestion events

or

nullOptional

filestring · binaryRequired

Responses

200

OK

application/json

resultany ofRequired

Knowledge base node

or

post

/webapi/v2/knowledge_base_nodes/upload

HTTPcURLJavaScriptPython

POST /webapi/v2/knowledge_base_nodes/upload HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 538

{
  "fileName": "text",
  "hashtags": [
    "text"
  ],
  "targetFolderId": "text",
  "isOverwriteFolderAccess": false,
  "accessPermissionGroups": [
    {
      "permissionGroupId": "text",
      "accessType": "order_1_editor"
    }
  ],
  "accessAgents": [
    {
      "agentId": "text",
      "accessType": "order_1_editor"
    }
  ],
  "accessUserFilters": [
    {
      "variableName": "CUSTOMER_ID",
      "value": "text"
    }
  ],
  "viewAccessToAgent": false,
  "viewAccessToUser": false,
  "useLayout": true,
  "useImageDescription": true,
  "useOcr": false,
  "properties": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "notificationHooks": [
    "email_on_ingestion_complete"
  ],
  "file": "binary"
}

200

OK

[
  {
    "result": {
      "id": "text",
      "name": "text",
      "createdAt": 1,
      "createdBy": {
        "id": "text",
        "email": "text",
        "firstName": "text",
        "lastName": "text"
      },
      "updatedAt": 1,
      "nodeType": "text",
      "parentFolder": {
        "id": "text",
        "name": "text"
      },
      "breadcrumbs": [
        {
          "id": "text",
          "name": "text"
        }
      ],
      "agentPermission": {
        "accessAgents": [
          {
            "agentId": "text",
            "accessType": "order_1_editor"
          }
        ],
        "accessPermissionGroups": [
          {
            "permissionGroupId": "text",
            "permissionGroupName": "text",
            "accessType": "order_1_editor"
          }
        ],
        "viewAccessToAgent": true
      },
      "userPermission": {
        "ownUserIds": [
          "text"
        ],
        "customerGroups": [
          "text"
        ],
        "viewAccessToUser": true
      }
    }
  }
]

Upload From Aws S3

post

https://backend.alli.aihttps://backend-ja.alli.ai

/webapi/v2/knowledge_base_nodes/upload_from_aws_s3

Upload Documents from S3

This API lets you transfer documents stored in S3 into Cognitive Search. They will appear as Knowledge Base documents in the dashboard. Available file formats are same in the section of Upload Documents.

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body

application/json

Request model for uploading files from S3.

fileNamestringRequired

The file name of the knowledge base

hashtagsany ofOptional

The hashtags of the knowledge base

string[]Optional

or

nullOptional

targetFolderIdany ofOptional

The target folder ID of the knowledge base

stringOptional

or

nullOptional

isOverwriteFolderAccessany ofOptional

The overwrite folder access flag of the knowledge base

Default: false

booleanOptional

or

nullOptional

accessPermissionGroupsany ofOptional

The access permission groups of the knowledge base

or

nullOptional

accessAgentsany ofOptional

The access agents of the knowledge base

or

nullOptional

accessUserFiltersany ofOptional

The access user filters of the knowledge base

or

nullOptional

viewAccessToAgentany ofOptional

The view access to agent flag of the knowledge base

Default: false

booleanOptional

or

nullOptional

viewAccessToUserany ofOptional

The view access to user flag of the knowledge base

Default: false

booleanOptional

or

nullOptional

useLayoutany ofOptional

Whether to use layout processing for improved document ingestion. Only used if project allows this feature.

Default: true

booleanOptional

or

nullOptional

useImageDescriptionany ofOptional

Whether to use image description for improved document ingestion. Only used if project allows this feature.

Default: true

booleanOptional

or

nullOptional

useOcrany ofOptional

Whether to use OCR for document processing

Default: false

booleanOptional

or

nullOptional

notificationHooksany ofOptional

List of notification hooks to trigger on document ingestion events

or

nullOptional

bucketObjectPathstringRequired

The bucket object path of the file

awsSecretKeyany ofOptional

Your S3 Secret Key.

stringOptional

or

nullOptional

awsAccessKeyany ofOptional

Your S3 Access Key.

stringOptional

or

nullOptional

awsIamRoleArnany ofOptional

AWS IAM Role ARN for access

stringOptional

or

nullOptional

awsExternalIdany ofOptional

External ID for AWS IAM Role

stringOptional

or

nullOptional

Responses

200

OK

application/json

resultany ofRequired

Knowledge base node

or

post

/webapi/v2/knowledge_base_nodes/upload_from_aws_s3

HTTPcURLJavaScriptPython

POST /webapi/v2/knowledge_base_nodes/upload_from_aws_s3 HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 638

{
  "fileName": "text",
  "hashtags": [
    "text"
  ],
  "targetFolderId": "text",
  "isOverwriteFolderAccess": false,
  "accessPermissionGroups": [
    {
      "permissionGroupId": "text",
      "accessType": "order_1_editor"
    }
  ],
  "accessAgents": [
    {
      "agentId": "text",
      "accessType": "order_1_editor"
    }
  ],
  "accessUserFilters": [
    {
      "variableName": "CUSTOMER_ID",
      "value": "text"
    }
  ],
  "viewAccessToAgent": false,
  "viewAccessToUser": false,
  "useLayout": true,
  "useImageDescription": true,
  "useOcr": false,
  "properties": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "notificationHooks": [
    "email_on_ingestion_complete"
  ],
  "bucketObjectPath": "text",
  "awsSecretKey": "text",
  "awsAccessKey": "text",
  "awsIamRoleArn": "text",
  "awsExternalId": "text"
}

200

OK

{
  "result": {
    "id": "text",
    "name": "text",
    "createdAt": 1,
    "createdBy": {
      "id": "text",
      "email": "text",
      "firstName": "text",
      "lastName": "text"
    },
    "updatedAt": 1,
    "nodeType": "text",
    "parentFolder": {
      "id": "text",
      "name": "text"
    },
    "breadcrumbs": [
      {
        "id": "text",
        "name": "text"
      }
    ],
    "agentPermission": {
      "accessAgents": [
        {
          "agentId": "text",
          "accessType": "order_1_editor"
        }
      ],
      "accessPermissionGroups": [
        {
          "permissionGroupId": "text",
          "permissionGroupName": "text",
          "accessType": "order_1_editor"
        }
      ],
      "viewAccessToAgent": true
    },
    "userPermission": {
      "ownUserIds": [
        "text"
      ],
      "customerGroups": [
        "text"
      ],
      "viewAccessToUser": true
    }
  }
}

Upload From Azure Blob

post

https://backend.alli.aihttps://backend-ja.alli.ai

/webapi/v2/knowledge_base_nodes/upload_from_azure_blob

Upload Documents from Azure Blob Storage

This API lets you transfer documents stored in Azure Blob Storage into Cognitive Search. They will appear as Knowledge Base documents in the dashboard. Available file formats are same in the section of Upload Documents.

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body

application/json

Request model for uploading files from Azure Blob Storage.

fileNamestringRequired

The file name of the knowledge base

hashtagsany ofOptional

The hashtags of the knowledge base

string[]Optional

or

nullOptional

targetFolderIdany ofOptional

The target folder ID of the knowledge base

stringOptional

or

nullOptional

isOverwriteFolderAccessany ofOptional

The overwrite folder access flag of the knowledge base

Default: false

booleanOptional

or

nullOptional

accessPermissionGroupsany ofOptional

The access permission groups of the knowledge base

or

nullOptional

accessAgentsany ofOptional

The access agents of the knowledge base

or

nullOptional

accessUserFiltersany ofOptional

The access user filters of the knowledge base

or

nullOptional

viewAccessToAgentany ofOptional

The view access to agent flag of the knowledge base

Default: false

booleanOptional

or

nullOptional

viewAccessToUserany ofOptional

The view access to user flag of the knowledge base

Default: false

booleanOptional

or

nullOptional

useLayoutany ofOptional

Whether to use layout processing for improved document ingestion. Only used if project allows this feature.

Default: true

booleanOptional

or

nullOptional

useImageDescriptionany ofOptional

Whether to use image description for improved document ingestion. Only used if project allows this feature.

Default: true

booleanOptional

or

nullOptional

useOcrany ofOptional

Whether to use OCR for document processing

Default: false

booleanOptional

or

nullOptional

notificationHooksany ofOptional

List of notification hooks to trigger on document ingestion events

or

nullOptional

containerBlobPathstringRequired

The container blob path of the file

azureConnectionStringstringOptional

Your Azure Blob Storage connection string.

Responses

200

OK

application/json

resultany ofRequired

Knowledge base node

or

post

/webapi/v2/knowledge_base_nodes/upload_from_azure_blob

HTTPcURLJavaScriptPython

POST /webapi/v2/knowledge_base_nodes/upload_from_azure_blob HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 580

{
  "fileName": "text",
  "hashtags": [
    "text"
  ],
  "targetFolderId": "text",
  "isOverwriteFolderAccess": false,
  "accessPermissionGroups": [
    {
      "permissionGroupId": "text",
      "accessType": "order_1_editor"
    }
  ],
  "accessAgents": [
    {
      "agentId": "text",
      "accessType": "order_1_editor"
    }
  ],
  "accessUserFilters": [
    {
      "variableName": "CUSTOMER_ID",
      "value": "text"
    }
  ],
  "viewAccessToAgent": false,
  "viewAccessToUser": false,
  "useLayout": true,
  "useImageDescription": true,
  "useOcr": false,
  "properties": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "notificationHooks": [
    "email_on_ingestion_complete"
  ],
  "containerBlobPath": "text",
  "azureConnectionString": "text"
}

200

OK

{
  "result": {
    "id": "text",
    "name": "text",
    "createdAt": 1,
    "createdBy": {
      "id": "text",
      "email": "text",
      "firstName": "text",
      "lastName": "text"
    },
    "updatedAt": 1,
    "nodeType": "text",
    "parentFolder": {
      "id": "text",
      "name": "text"
    },
    "breadcrumbs": [
      {
        "id": "text",
        "name": "text"
      }
    ],
    "agentPermission": {
      "accessAgents": [
        {
          "agentId": "text",
          "accessType": "order_1_editor"
        }
      ],
      "accessPermissionGroups": [
        {
          "permissionGroupId": "text",
          "permissionGroupName": "text",
          "accessType": "order_1_editor"
        }
      ],
      "viewAccessToAgent": true
    },
    "userPermission": {
      "ownUserIds": [
        "text"
      ],
      "customerGroups": [
        "text"
      ],
      "viewAccessToUser": true
    }
  }
}

Knowledge Base Nodes

post

https://backend.alli.aihttps://backend-ja.alli.ai

/webapi/v2/knowledge_base_nodes/search

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body

application/json

filter_any ofOptional

The filter of the knowledge base node

or

nullOptional

filterany ofOptional

The filter of the knowledge base node

or

nullOptional

orderstring · enumOptionalPossible values:

limitintegerOptional

The limit of the knowledge base node

Default: 10

afterany ofOptional

The after of the knowledge base node

stringOptional

or

nullOptional

offsetany ofOptional

The offset of the knowledge base node

integerOptional

or

nullOptional

Responses

200

OK

application/json

post

/webapi/v2/knowledge_base_nodes/search

HTTPcURLJavaScriptPython

POST /webapi/v2/knowledge_base_nodes/search HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 985

{
  "filter_": {
    "parentFolderIds": [
      "text"
    ],
    "searchTerm": "text",
    "hashtags": [
      "text"
    ],
    "hashtagsSearchOperator": "text",
    "combinedHashtags": [
      [
        "text"
      ]
    ],
    "combinedHashtagsOperator": "text",
    "excludingHashtags": [
      "text"
    ],
    "excludingHashtagsSearchOperator": "text",
    "processState": [
      "initializing"
    ],
    "status": [
      "on"
    ],
    "nodeType": [
      "file"
    ],
    "knowledgeBaseIds": [
      "text"
    ],
    "folderIds": [
      "text"
    ],
    "ownership": [
      "personal"
    ],
    "ancestorIds": [
      "text"
    ],
    "hasFaqCandidates": true,
    "sourceTypes": [
      "onedrive"
    ]
  },
  "filter": {
    "parentFolderIds": [
      "text"
    ],
    "searchTerm": "text",
    "hashtags": [
      "text"
    ],
    "hashtagsSearchOperator": "text",
    "combinedHashtags": [
      [
        "text"
      ]
    ],
    "combinedHashtagsOperator": "text",
    "excludingHashtags": [
      "text"
    ],
    "excludingHashtagsSearchOperator": "text",
    "processState": [
      "initializing"
    ],
    "status": [
      "on"
    ],
    "nodeType": [
      "file"
    ],
    "knowledgeBaseIds": [
      "text"
    ],
    "folderIds": [
      "text"
    ],
    "ownership": [
      "personal"
    ],
    "ancestorIds": [
      "text"
    ],
    "hasFaqCandidates": true,
    "sourceTypes": [
      "onedrive"
    ]
  },
  "order": "updated_at_desc",
  "limit": 10,
  "after": "text",
  "offset": 1
}

200

OK

{
  "result": {
    "nodes": [
      {
        "id": "text",
        "name": "text",
        "createdAt": 1,
        "createdBy": {
          "id": "text",
          "email": "text",
          "firstName": "text",
          "lastName": "text"
        },
        "updatedAt": 1,
        "nodeType": "text",
        "parentFolder": {
          "id": "text",
          "name": "text"
        },
        "breadcrumbs": [
          {
            "id": "text",
            "name": "text"
          }
        ],
        "agentPermission": {
          "accessAgents": [
            {
              "agentId": "text",
              "accessType": "order_1_editor"
            }
          ],
          "accessPermissionGroups": [
            {
              "permissionGroupId": "text",
              "permissionGroupName": "text",
              "accessType": "order_1_editor"
            }
          ],
          "viewAccessToAgent": true
        },
        "userPermission": {
          "ownUserIds": [
            "text"
          ],
          "customerGroups": [
            "text"
          ],
          "viewAccessToUser": true
        }
      }
    ],
    "cursor": "text",
    "totalFileCount": 1,
    "totalFolderCount": 1
  }
}

Content Search

post

https://backend.alli.aihttps://backend-ja.alli.ai

/webapi/v2/knowledge_base_nodes/content_search

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body

application/json

searchTermstringRequired

The search term of the knowledge base node

limitintegerOptional

The limit of the knowledge base node

Default: 10

afterany ofOptional

The after of the knowledge base node

stringOptional

or

nullOptional

folderIdsany ofOptional

The folder IDs of the knowledge base node

string[]Optional

or

nullOptional

searchScopestring · enumOptionalPossible values:

Responses

200

OK

application/json

post

/webapi/v2/knowledge_base_nodes/content_search

HTTPcURLJavaScriptPython

POST /webapi/v2/knowledge_base_nodes/content_search HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 89

{
  "searchTerm": "text",
  "limit": 10,
  "after": "text",
  "folderIds": [
    "text"
  ],
  "searchScope": "both"
}

200

OK

{
  "result": {
    "nodes": [
      {
        "id": "text",
        "name": "text",
        "createdAt": 1,
        "createdBy": {
          "id": "text",
          "email": "text",
          "firstName": "text",
          "lastName": "text"
        },
        "updatedAt": 1,
        "nodeType": "text",
        "parentFolder": {
          "id": "text",
          "name": "text"
        },
        "breadcrumbs": [
          {
            "id": "text",
            "name": "text"
          }
        ],
        "agentPermission": {
          "accessAgents": [
            {
              "agentId": "text",
              "accessType": "order_1_editor"
            }
          ],
          "accessPermissionGroups": [
            {
              "permissionGroupId": "text",
              "permissionGroupName": "text",
              "accessType": "order_1_editor"
            }
          ],
          "viewAccessToAgent": true
        },
        "userPermission": {
          "ownUserIds": [
            "text"
          ],
          "customerGroups": [
            "text"
          ],
          "viewAccessToUser": true
        }
      }
    ],
    "cursor": "text",
    "totalFileCount": 1,
    "totalFolderCount": 1
  }
}

Page Content Search

post

https://backend.alli.aihttps://backend-ja.alli.ai

/webapi/v2/knowledge_base_nodes/page_content_search

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body

application/json

searchTermsstring[]Required

The search terms for page content search

folderIdsany ofOptional

The folder IDs to search within

string[]Optional

or

nullOptional

knowledgeBaseIdsany ofOptional

The knowledge base IDs to search within

string[]Optional

or

nullOptional

hashtagsany ofOptional

The hashtags to filter by

string[]Optional

or

nullOptional

hashtagsOperatorstringOptional

The hashtags operator (AND/OR)

Default: OR

excludeHashtagsany ofOptional

The hashtags to exclude

string[]Optional

or

nullOptional

excludeHashtagsOperatorstringOptional

The exclude hashtags operator (AND/OR)

Default: OR

topNintegerOptional

The number of top results to return

Default: 1

mergeSamePagebooleanOptional

Whether to merge content from the same page

Default: false

Responses

200

OK

application/json

Response model for page content search containing list of page content items with metadata.

post

/webapi/v2/knowledge_base_nodes/page_content_search

HTTPcURLJavaScriptPython

POST /webapi/v2/knowledge_base_nodes/page_content_search HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 206

{
  "searchTerms": [
    "text"
  ],
  "folderIds": [
    "text"
  ],
  "knowledgeBaseIds": [
    "text"
  ],
  "hashtags": [
    "text"
  ],
  "hashtagsOperator": "OR",
  "excludeHashtags": [
    "text"
  ],
  "excludeHashtagsOperator": "OR",
  "topN": 1,
  "mergeSamePage": false
}

200

OK

{
  "results": [
    {
      "kbId": "text",
      "title": "text",
      "text": "text",
      "pageNo": 1
    }
  ]
}

Knowledge Base Node

get

https://backend.alli.aihttps://backend-ja.alli.ai

/webapi/v2/knowledge_base_nodes/{node_id}

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Path parameters

node_idstringRequired

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses

200

OK

application/json

resultany ofRequired

Knowledge base node

or

get

/webapi/v2/knowledge_base_nodes/{node_id}

HTTPcURLJavaScriptPython

GET /webapi/v2/knowledge_base_nodes/{node_id} HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

200

OK

{
  "result": {
    "id": "text",
    "name": "text",
    "createdAt": 1,
    "createdBy": {
      "id": "text",
      "email": "text",
      "firstName": "text",
      "lastName": "text"
    },
    "updatedAt": 1,
    "nodeType": "text",
    "parentFolder": {
      "id": "text",
      "name": "text"
    },
    "breadcrumbs": [
      {
        "id": "text",
        "name": "text"
      }
    ],
    "agentPermission": {
      "accessAgents": [
        {
          "agentId": "text",
          "accessType": "order_1_editor"
        }
      ],
      "accessPermissionGroups": [
        {
          "permissionGroupId": "text",
          "permissionGroupName": "text",
          "accessType": "order_1_editor"
        }
      ],
      "viewAccessToAgent": true
    },
    "userPermission": {
      "ownUserIds": [
        "text"
      ],
      "customerGroups": [
        "text"
      ],
      "viewAccessToUser": true
    }
  }
}

Update Knowledge Base Node

put

https://backend.alli.aihttps://backend-ja.alli.ai

/webapi/v2/knowledge_base_nodes/{node_id}

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Path parameters

node_idstringRequired

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body

application/json

titleany ofOptional

The title of the knowledge base node

stringOptional

or

nullOptional

hashtagsany ofOptional

The hashtags of the knowledge base node

string[]Optional

or

nullOptional

is_overwrite_folder_accessany ofOptional

The overwrite folder access flag of the knowledge base node

booleanOptional

or

nullOptional

access_permission_groupsany ofOptional

The access permission groups of the knowledge base node

or

nullOptional

access_agentsany ofOptional

The access agents of the knowledge base node

or

nullOptional

access_user_filtersany ofOptional

The access user filters of the knowledge base node

or

nullOptional

view_access_to_agentany ofOptional

The view access to agent flag of the knowledge base node

booleanOptional

or

nullOptional

view_access_to_userany ofOptional

The view access to user flag of the knowledge base node

booleanOptional

or

nullOptional

Responses

200

OK

application/json

resultany ofRequired

Knowledge base node

or

put

/webapi/v2/knowledge_base_nodes/{node_id}

HTTPcURLJavaScriptPython

PUT /webapi/v2/knowledge_base_nodes/{node_id} HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 395

{
  "title": "text",
  "hashtags": [
    "text"
  ],
  "is_overwrite_folder_access": true,
  "access_permission_groups": [
    {
      "permissionGroupId": "text",
      "accessType": "order_1_editor"
    }
  ],
  "access_agents": [
    {
      "agentId": "text",
      "accessType": "order_1_editor"
    }
  ],
  "access_user_filters": [
    {
      "variableName": "CUSTOMER_ID",
      "value": "text"
    }
  ],
  "view_access_to_agent": true,
  "view_access_to_user": true,
  "properties": [
    {
      "key": "text",
      "value": "text"
    }
  ]
}

200

OK

{
  "result": {
    "id": "text",
    "name": "text",
    "createdAt": 1,
    "createdBy": {
      "id": "text",
      "email": "text",
      "firstName": "text",
      "lastName": "text"
    },
    "updatedAt": 1,
    "nodeType": "text",
    "parentFolder": {
      "id": "text",
      "name": "text"
    },
    "breadcrumbs": [
      {
        "id": "text",
        "name": "text"
      }
    ],
    "agentPermission": {
      "accessAgents": [
        {
          "agentId": "text",
          "accessType": "order_1_editor"
        }
      ],
      "accessPermissionGroups": [
        {
          "permissionGroupId": "text",
          "permissionGroupName": "text",
          "accessType": "order_1_editor"
        }
      ],
      "viewAccessToAgent": true
    },
    "userPermission": {
      "ownUserIds": [
        "text"
      ],
      "customerGroups": [
        "text"
      ],
      "viewAccessToUser": true
    }
  }
}

Delete Knowledge Base Nodes

delete

https://backend.alli.aihttps://backend-ja.alli.ai

/webapi/v2/knowledge_base_nodes/{node_id}

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Path parameters

node_idstringRequired

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses

200

OK

No content

delete

/webapi/v2/knowledge_base_nodes/{node_id}

HTTPcURLJavaScriptPython

DELETE /webapi/v2/knowledge_base_nodes/{node_id} HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

200

OK

No content

Knowledge Base Node Preview

get

https://backend.alli.aihttps://backend-ja.alli.ai

/webapi/v2/knowledge_base_nodes/{node_id}/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

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Path parameters

node_idstringRequired

Query parameters

page_nointegerOptionalDefault: 1

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses

200

OK

application/json

Response model for knowledge base preview containing HTML and PDF information.

htmlany ofOptional

HTML preview of the knowledge base

stringOptional

or

nullOptional

pdfUrlany ofOptional

PDF preview of the knowledge base

stringOptional

or

nullOptional

imageUrlany ofOptional

Image preview of the knowledge base

stringOptional

or

nullOptional

previewUrlany ofOptional

Preview URL of the knowledge base

stringOptional

or

nullOptional

totalPreviewCountintegerOptional

Total preview count of the knowledge base

Default: 0

piiMaskedbooleanOptional

Whether the preview is hidden due to PII masking

Default: false

get

/webapi/v2/knowledge_base_nodes/{node_id}/preview

HTTPcURLJavaScriptPython

GET /webapi/v2/knowledge_base_nodes/{node_id}/preview HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

200

OK

{
  "html": "text",
  "pdfUrl": "text",
  "imageUrl": "text",
  "previewUrl": "text",
  "totalPreviewCount": 0,
  "piiMasked": false
}

Knowledge Base Node Text

get

https://backend.alli.aihttps://backend-ja.alli.ai

/webapi/v2/knowledge_base_nodes/{node_id}/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

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Path parameters

node_idstringRequired

Query parameters

limitany ofOptional

integerOptional

or

nullOptional

offsetany ofOptional

integerOptional

or

nullOptional

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses

200

OK

No content

get

/webapi/v2/knowledge_base_nodes/{node_id}/text

HTTPcURLJavaScriptPython

GET /webapi/v2/knowledge_base_nodes/{node_id}/text HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

200

OK

No content

Knowledge Base Node Download

get

https://backend.alli.aihttps://backend-ja.alli.ai

/webapi/v2/knowledge_base_nodes/{node_id}/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

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Path parameters

node_idstringRequired

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses

200

OK

No content

get

/webapi/v2/knowledge_base_nodes/{node_id}/download

HTTPcURLJavaScriptPython

GET /webapi/v2/knowledge_base_nodes/{node_id}/download HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

200

OK

No content

Create Folder

post

https://backend.alli.aihttps://backend-ja.alli.ai

/webapi/v2/folders

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body

application/json

namestring · max: 50Required

parentFolderIdany ofOptional

stringOptional

or

nullOptional

followParentFolderPermissionany ofOptionalDefault: false

booleanOptional

or

nullOptional

permissionGroupEditorsany ofOptional

or

nullOptional

permissionGroupViewersany ofOptional

or

nullOptional

agentEditorsany ofOptional

string[]Optional

or

nullOptional

agentViewersany ofOptional

string[]Optional

or

nullOptional

userViewersany ofOptional

or

nullOptional

allowOtherAgentsViewbooleanOptionalDefault: true

allowOtherUsersViewbooleanOptionalDefault: true

Responses

200

OK

application/json

idstringRequired

namestringRequired

createdAtnumberRequired

updatedAtnumberRequired

parentFolderIdany ofOptional

stringOptional

or

nullOptional

folderSizeany ofOptional

integerOptional

or

nullOptional

post

/webapi/v2/folders

HTTPcURLJavaScriptPython

POST /webapi/v2/folders HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 302

{
  "name": "text",
  "parentFolderId": "text",
  "followParentFolderPermission": false,
  "permissionGroupEditors": [],
  "permissionGroupViewers": [],
  "agentEditors": [
    "text"
  ],
  "agentViewers": [
    "text"
  ],
  "userViewers": {
    "customerIds": [
      "text"
    ],
    "customerGroupIds": [
      "text"
    ]
  },
  "allowOtherAgentsView": true,
  "allowOtherUsersView": true
}

200

OK

{
  "id": "text",
  "name": "text",
  "createdAt": 1,
  "updatedAt": 1,
  "parentFolderId": "text",
  "folderSize": 1
}

Get Folder

get

https://backend.alli.aihttps://backend-ja.alli.ai

/webapi/v2/folders/{folder_id}

Get a single folder by ID with folder size information.

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Path parameters

folder_idstringRequired

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses

200

OK

application/json

idstringRequired

namestringRequired

createdAtnumberRequired

updatedAtnumberRequired

parentFolderIdany ofOptional

stringOptional

or

nullOptional

folderSizeany ofOptional

integerOptional

or

nullOptional

get

/webapi/v2/folders/{folder_id}

HTTPcURLJavaScriptPython

GET /webapi/v2/folders/{folder_id} HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

200

OK

{
  "id": "text",
  "name": "text",
  "createdAt": 1,
  "updatedAt": 1,
  "parentFolderId": "text",
  "folderSize": 1
}

Update Folder

put

https://backend.alli.aihttps://backend-ja.alli.ai

/webapi/v2/folders/{folder_id}

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Path parameters

folder_idstringRequired

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body

application/json

namestring · max: 50Required

permissionGroupEditorsany ofOptional

or

nullOptional

permissionGroupViewersany ofOptional

or

nullOptional

agentEditorsany ofOptional

string[]Optional

or

nullOptional

agentViewersany ofOptional

string[]Optional

or

nullOptional

userViewersany ofOptional

or

nullOptional

allowOtherAgentsViewany ofOptional

booleanOptional

or

nullOptional

allowOtherUsersViewany ofOptional

booleanOptional

or

nullOptional

Responses

200

OK

application/json

idstringRequired

namestringRequired

createdAtnumberRequired

updatedAtnumberRequired

parentFolderIdany ofOptional

stringOptional

or

nullOptional

folderSizeany ofOptional

integerOptional

or

nullOptional

put

/webapi/v2/folders/{folder_id}

HTTPcURLJavaScriptPython

PUT /webapi/v2/folders/{folder_id} HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 241

{
  "name": "text",
  "permissionGroupEditors": [],
  "permissionGroupViewers": [],
  "agentEditors": [
    "text"
  ],
  "agentViewers": [
    "text"
  ],
  "userViewers": {
    "customerIds": [
      "text"
    ],
    "customerGroupIds": [
      "text"
    ]
  },
  "allowOtherAgentsView": true,
  "allowOtherUsersView": true
}

200

OK

{
  "id": "text",
  "name": "text",
  "createdAt": 1,
  "updatedAt": 1,
  "parentFolderId": "text",
  "folderSize": 1
}

Delete Folder

delete

https://backend.alli.aihttps://backend-ja.alli.ai

/webapi/v2/folders/{folder_id}

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Path parameters

folder_idstringRequired

Query parameters

move_docs_out_of_folderbooleanOptionalDefault: false

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses

200

OK

No content

delete

/webapi/v2/folders/{folder_id}

HTTPcURLJavaScriptPython

DELETE /webapi/v2/folders/{folder_id} HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

200

OK

No content

Knowledge Base Diff

post

https://backend.alli.aihttps://backend-ja.alli.ai

/webapi/v2/knowledge_base_diff

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body

application/json

leftIdstringRequired

The left knowledge base ID

rightIdstringRequired

The right knowledge base ID

Responses

200

OK

application/json

post

/webapi/v2/knowledge_base_diff

HTTPcURLJavaScriptPython

POST /webapi/v2/knowledge_base_diff HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "leftId": "text",
  "rightId": "text"
}

200

OK

{
  "result": [
    {
      "left": {
        "status": "text",
        "page": 1,
        "line": 1,
        "text": "text",
        "highlight": "text"
      },
      "right": {
        "status": "text",
        "page": 1,
        "line": 1,
        "text": "text",
        "highlight": "text"
      },
      "row": 1,
      "comment": "text"
    }
  ]
}

Get Embedding Status

get

https://backend.alli.aihttps://backend-ja.alli.ai

/webapi/v2/embedding_status

Per-status embedding page counts for the project.

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses

200

OK

No content

get

/webapi/v2/embedding_status

HTTPcURLJavaScriptPython

GET /webapi/v2/embedding_status HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

200

OK

No content

Get Embedding Docs

get

https://backend.alli.aihttps://backend-ja.alli.ai

/webapi/v2/embedding_status/docs

List knowledge base docs with embedding status, filtered and paginated.

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Query parameters

statusstringOptionalDefault: ""

pageintegerOptionalDefault: 1

searchstringOptionalDefault: ""

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses

200

OK

No content

get

/webapi/v2/embedding_status/docs

HTTPcURLJavaScriptPython

GET /webapi/v2/embedding_status/docs HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

200

OK

No content

Reset Embedding

post

https://backend.alli.aihttps://backend-ja.alli.ai

/webapi/v2/embedding_status/reset

Reset parsed pages to re-embed. scope='all' resets everything, scope='failed' retries failures only.

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body

application/json

scopestringOptionalDefault: all

Responses

200

OK

No content

post

/webapi/v2/embedding_status/reset

HTTPcURLJavaScriptPython

POST /webapi/v2/embedding_status/reset HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "scope": "all"
}

200

OK

No content

Get Es Count

get

https://backend.alli.aihttps://backend-ja.alli.ai

/webapi/v2/embedding_status/{kb_id}/es-count

Check if a knowledge base document is indexed in Elasticsearch.

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Path parameters

kb_idstringRequired

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses

200

OK

No content

get

/webapi/v2/embedding_status/{kb_id}/es-count

HTTPcURLJavaScriptPython

GET /webapi/v2/embedding_status/{kb_id}/es-count HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

200

OK

No content

Download document by filename

get

https://backend.alli.aihttps://backend-ja.alli.ai

/download_document_by_name/{project_id}

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Path parameters

project_idstringRequired

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body

application/json

filenamestringOptional

Name of the document to download

Responses

200

Document file downloaded successfully

application/octet-stream

string · binaryOptional

400

Multiple documents found

401

Unauthorized

403

Forbidden or downloads disabled

404

Document not found

500

Internal server error

get

/download_document_by_name/{project_id}

HTTPcURLJavaScriptPython

GET /download_document_by_name/{project_id} HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "filename": "text"
}

binary

Get Single Document

get

https://backend.alli.aihttps://backend-ja.alli.ai

/webapi/single_document

This is the method to get all details of a single document.

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Query parameters

idstringRequired

The id of the document.

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses

200

Successfully retrieved document details

application/json

get

/webapi/single_document

HTTPcURLJavaScriptPython

GET /webapi/single_document?id=text HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

200

Successfully retrieved document details

{
  "result": {
    "id": "text",
    "documentName": "text",
    "createdDate": "2026-05-13",
    "hashtags": [
      "text"
    ],
    "agentFeedback": {
      "positiveCount": 1,
      "negativeCount": 1
    },
    "userFeedback": {
      "positiveCount": 1,
      "negativeCount": 1
    }
  }
}

Upload Documents

post

https://backend.alli.aihttps://backend-ja.alli.ai

/webapi/upload_file

This API method allows you to upload documents for Cognitive Search. Available file formats for the upload: PDF, TXT, MS Word, PowerPoint, Excel, HTM and HTML. To upload a HTML file with linked resources, please compress in a ZIP file along with any relative linked resources before uploading.

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body

multipart/form-data

filestring · binaryOptional

Your local file location

hashtagsstring[]Optional

Hashtags for the uploading file

footerTitlestringOptional

You can type in the source of the answer as a footer for search results from the uploaded file. The footer text will appear next to 'From' in search results.

footerUrlstringOptional

You can put the URL you want to link to the footerTitle.

parentFolderIdstringOptional

Target folder ID to upload to. Null to insert at top level.

allowOtherAgentsViewbooleanOptional

Whether to allow other agents to view this document

allowOtherUsersViewbooleanOptional

Whether to allow other users to view this document

useLayoutbooleanOptional

Whether to use layout processing for improved document ingestion. If null, project setting will be used.

useImageDescriptionbooleanOptional

Whether to use image description for improved document ingestion. If null, project setting will be used.

Responses

200

File uploaded successfully

application/json

400

Invalid request or file format

413

File size exceeds limit

post

/webapi/upload_file

HTTPcURLJavaScriptPython

POST /webapi/upload_file HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 248

{
  "file": "binary",
  "hashtags": [
    "text"
  ],
  "footerTitle": "text",
  "footerUrl": "text",
  "parentFolderId": "text",
  "allowOtherAgentsView": true,
  "allowOtherUsersView": true,
  "useLayout": true,
  "useImageDescription": true,
  "properties": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

{
  "result": {
    "id": "text",
    "file_name": "text",
    "hashtags": [
      "text"
    ],
    "footer": "text"
  }
}

Upload Documents from S3

post

https://backend.alli.aihttps://backend-ja.alli.ai

/webapi/upload_from_s3

This API lets you transfer documents stored in S3 into Cognitive Search. They will appear as Knowledge Base documents in the dashboard. Available file formats are same in the section of Upload Documents.

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body

application/json

pathstringOptional

S3 path of the file. It should end with the file name. Don't include the bucket name

secretKeystringOptional

Your S3 Secret Key.

accessKeystringOptional

Your S3 Access Key.

bucketstringOptional

Name of S3 bucket containing your file.

footerTitlestringOptional

You can type in the source of the answer as a footer for search results from the uploaded file. The footer text will appear next to 'From' in search results.

footerUrlstringOptional

You can put the URL you want to link to the footerTitle.

hashtagsstring[]Optional

Hashtags for the document.

parentFolderIdstringOptional

Target folder ID to upload to. Null to insert at top level.

Responses

200

File uploaded successfully from S3

application/json

400

Invalid request parameters

404

File not found in S3

post

/webapi/upload_from_s3

HTTPcURLJavaScriptPython

POST /webapi/upload_from_s3 HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 201

{
  "path": "text",
  "secretKey": "text",
  "accessKey": "text",
  "bucket": "text",
  "footerTitle": "text",
  "footerUrl": "text",
  "hashtags": [
    "text"
  ],
  "parentFolderId": "text",
  "properties": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

{
  "result": {
    "id": "text",
    "file_name": "text",
    "hashtags": [
      "text"
    ],
    "footer": "text"
  }
}

Check Document Status

get

https://backend.alli.aihttps://backend-ja.alli.ai

/webapi/check_file_status

Once you upload documents through API, it is converted, parsed, and embedded as vectors. This API shows the status of the process for a document being uploaded.

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Query parameters

idstringRequired

The document id to check the status

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses

200

File status retrieved successfully

application/json

400

Invalid task ID or file not found

get

/webapi/check_file_status

HTTPcURLJavaScriptPython

GET /webapi/check_file_status?id=text HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

{
  "result": {
    "id": "text",
    "status": "text",
    "errorName": "text"
  }
}

Rename Documents (Knowledge Base)

post

https://backend.alli.aihttps://backend-ja.alli.ai

/webapi/update_kb_name

This API lets you update the name for an uploaded document.

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body

application/json

idstringOptional

The document ID that you want to rename.

filenamestringOptional

The new name for the specified document.

Responses

200

Knowledge base name updated successfully

application/json

400

Invalid parameters

post

/webapi/update_kb_name

HTTPcURLJavaScriptPython

POST /webapi/update_kb_name HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "id": "text",
  "filename": "text"
}

{
  "result": {
    "id": "text",
    "filename": "text"
  }
}

Search Documents by Title

get

https://backend.alli.aihttps://backend-ja.alli.ai

/webapi/search_document_by_title

This API allows you to search for documents by their titles, not their content.

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Query parameters

querystringRequired

The search term for document titles.

hashtagsstringOptional

Comma-separated list of hashtags to filter documents by.

combinedHashtagsstringOptional

Complex hashtag filtering using semicolons to separate groups and commas to separate tags within a group (e.g., "a,b;c,d").

excludingHashtagsstringOptional

Comma-separated list of hashtags to exclude documents by.

useVectorstringOptional

Set to 'true' to use vector search for semantic matching, or 'false' for text-based search.

sortKeystringOptional

The property field to sort results by.

sortDirectionstring · enumOptional

The direction to sort results in (ascending or descending).

Possible values:

offsetintegerOptional

Number of results to skip for pagination.

limitintegerOptional

Maximum number of results to return.

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses

200

Successfully searched documents by title

application/json

get

/webapi/search_document_by_title

HTTPcURLJavaScriptPython

GET /webapi/search_document_by_title?query=text HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

200

Successfully searched documents by title

{
  "result": [
    {
      "id": "text",
      "file_name": "text",
      "page_count": 1,
      "download_url": "text",
      "hashtags": [
        "text"
      ],
      "score": 1,
      "folder": "text",
      "agentEditor": [
        "text"
      ],
      "agentViewer": [
        "text"
      ]
    }
  ]
}

Delete Documents

post

https://backend.alli.aihttps://backend-ja.alli.ai

/webapi/delete_file

This API lets you delete uploaded files.

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body

application/json

idsstring[]Optional

The document IDs that you want to delete in the array format

Responses

200

Files deleted successfully

application/json

errorsobject · nullableOptional

If the deletion fails, this will contain an error message

post

/webapi/delete_file

HTTPcURLJavaScriptPython

POST /webapi/delete_file HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "ids": [
    "text"
  ]
}

200

Files deleted successfully

{
  "result": {
    "ok": true
  },
  "errors": {}
}

List Documents

get

https://backend.alli.aihttps://backend-ja.alli.ai

/webapi/knowledge_bases

This API lets you list out the uploaded documents.

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Query parameters

hashtagsSearchOperatorstring · enumOptional

Either AND or OR, logical operator used to match multiple hashtags. Defaults to OR.

Default: ORPossible values:

statusbooleanOptional

The on/off status of the document to filter the list.

searchTermstringOptional

Keyword search query to filter the list. You can use operators to run advanced searches. "TERM1 TERM2" for AND, "TERM1 OR TERM2" for OR, and "TERM\ for exact match.

hashtagsstring[]Optional

Hashtag information to filter the list.

orderstring · enumOptional

The order type of the list. FILE_NAME_ASC/DESC for file name, TYPE_ASC/DESC for file type, STATUS_ASC/DESC for on/off status, CREATED_AT_ASC/DESC for upload date.

Possible values:

offsetintegerOptional

offset allows you to specify the ranking number of the first item on the page.

limitinteger · min: 1 · max: 100Optional

limit allows you to set the number of objects returned on one page. The maximum value is 100.

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses

200

Successfully retrieved list of documents

application/json

errorsobject · nullableOptional

Error information if the request fails

get

/webapi/knowledge_bases

HTTPcURLJavaScriptPython

GET /webapi/knowledge_bases HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

200

Successfully retrieved list of documents

{
  "result": {
    "items": [
      {
        "id": "text",
        "fileName": "text",
        "hashtags": [
          "text"
        ],
        "autoHashtags": [
          {}
        ],
        "folder": "text",
        "agentEditor": [
          "text"
        ],
        "agentViewer": [
          "text"
        ],
        "userViewer": {
          "variables": {}
        },
        "allowOtherAgentsView": true,
        "allowOtherUsersView": true
      }
    ]
  },
  "errors": {}
}

Preview Documents

get

https://backend.alli.aihttps://backend-ja.alli.ai

/webapi/knowledge_base_preview

This API lets you preview the uploaded documents.

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Query parameters

idstringRequired

The document ID that you want to preview

pageNostringRequired

Pages of the document you want to preview

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses

200

Successfully retrieved document preview

application/json

errorsobject · nullableOptional

Error information if the request fails

get

/webapi/knowledge_base_preview

HTTPcURLJavaScriptPython

GET /webapi/knowledge_base_preview?id=text&pageNo=text HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

200

Successfully retrieved document preview

{
  "result": {
    "totalPageCount": 1,
    "pageNo": 1,
    "css": "text",
    "body": "text",
    "highlightIndexes": [
      1
    ],
    "exactAnswer": "text",
    "pdf": "text",
    "draftjs": "text",
    "highlights": {
      "indexes": [
        1
      ],
      "pageIndexes": [
        1
      ],
      "__typename": "text"
    },
    "knowledgeBase": {
      "id": "text",
      "title": "text",
      "__typename": "text"
    },
    "__typename": "text"
  },
  "errors": {}
}

Update Documents

post

https://backend.alli.aihttps://backend-ja.alli.ai

/webapi/update_document

This API lets you update hashtags, footer title, and footer title link for a document.

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body

application/json

idstringRequired

The id of the document you want to update

footerTitlestringOptional

You can type in the source of the answer as a footer for search results from the uploaded file. The footer text will appear next to 'From' in search results.

footerUrlstringOptional

You can put the URL you want to link to the footerTitle.

folderstringOptional

You can assign the destination folder for document upload.

followFolderPermissionbooleanOptional

Whether to follow the folder's permission settings.

agentsEditorstring[]Optional

Specify agents that have editor permissions for the file.

agentsViewerstring[]Optional

Specify agents that have viewer permissions for the file.

allowOtherAgentsViewbooleanOptional

Agents not included in viewers/editors can also view the document.

allowOtherUsersViewbooleanOptional

Users not included in viewers/editors can also view the document.

hashtagsstring[]Optional

List of string hashtags you want to add to the document

Responses

200

Document updated successfully

application/json

errorsobject · nullableOptional

Error information if the request fails

post

/webapi/update_document

HTTPcURLJavaScriptPython

POST /webapi/update_document HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 334

{
  "id": "text",
  "footerTitle": "text",
  "footerUrl": "text",
  "folder": "text",
  "followFolderPermission": true,
  "agentsEditor": [
    "text"
  ],
  "agentsViewer": [
    "text"
  ],
  "userViewer": {
    "customer_id": [
      "text"
    ],
    "customer_group": [
      "text"
    ]
  },
  "allowOtherAgentsView": true,
  "allowOtherUsersView": true,
  "hashtags": [
    "text"
  ],
  "properties": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

200

Document updated successfully

{
  "result": {
    "knowledgeBase": {
      "id": "text",
      "hashtags": [
        "text"
      ],
      "footer": "text"
    }
  },
  "errors": {}
}

Knowledge Base Toggle Status

post

https://backend.alli.aihttps://backend-ja.alli.ai

/webapi/toggle_documents

This API lets you change the status of many documents (AKA knowledge bases) at once

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body

application/json

usebooleanRequired

Whether to turn all the status of all the knowledge bases to on (True) or off (False)

idsstring[]Required

This is a list of the ids of the knowledge bases that you want to toggle.

Responses

200

Knowledge base statuses toggled successfully

application/json

errorsobject · nullableOptional

Error information if the request fails

post

/webapi/toggle_documents

HTTPcURLJavaScriptPython

POST /webapi/toggle_documents HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "use": true,
  "ids": [
    "text"
  ]
}

200

Knowledge base statuses toggled successfully

{
  "result": {
    "knowledgeBases": [
      {
        "id": "text",
        "status": true
      }
    ]
  },
  "errors": {}
}