Knowledge_base_nodes

Knowledge base node related APIs

Move Knowledge Base Nodes

post

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

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

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

Default: []

or

nullOptional

accessAgentsany ofOptional

The access agents of the knowledge base

Default: []

or

nullOptional

accessUserFiltersany ofOptional

The access user filters of the knowledge base

Default: []

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

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

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

Default: []

or

nullOptional

accessAgentsany ofOptional

The access agents of the knowledge base

Default: []

or

nullOptional

accessUserFiltersany ofOptional

The access user filters of the knowledge base

Default: []

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

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

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

Default: []

or

nullOptional

accessAgentsany ofOptional

The access agents of the knowledge base

Default: []

or

nullOptional

accessUserFiltersany ofOptional

The access user filters of the knowledge base

Default: []

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

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

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

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

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

searchScopeall ofOptional

The search scope of the knowledge base node

Default: both

string · 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

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

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

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

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

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

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

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

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

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
}

Knowledge Base Node Text

get

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

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