Knowledge Bases
The Knowledge Bases API allows you to list, create, update, retrieve, and delete knowledge bases.
List knowledge bases#
Endpoints#
GET aisvc/api/v1/knowledgebasesRequest#
Query parameters#
| Parameter | Type | Description | Required |
|---|---|---|---|
_offset | Number | Number of results to skip | Optional |
_pageSize | Number | Number of results per page | Optional |
_id | String | Filter by id | Optional |
_name | String | Filter by name | Optional |
_userType | String | Filter by user type | Optional |
_vectorizedStatus | String | Filter by vectorization status (e.g., VECTORIZED, PENDING) | Optional |
query | String | Wildcard search on name | Optional |
Request example#
None
Response#
Codes#
| Code | Description |
|---|---|
200 | Success |
400 | Bad Request |
404 | Not Found |
Response body#
{ "_list": [ { "_id": "18e6bbd5-e364-4411-b2c4-eb0cc9a28037", "_name": "Warranty doc", "_fileId": "217fd20f-3925-434f-a97c-6be03d93f51e", "_fileVersionId": "04f4476f-495a-4991-8ad0-b849b93fea1c", "_vectorizedStatus": "VECTORIZED", "_userType": "warranty_info1", "_namespaces": [ "testproject_Lik2UwIN" ], "_irn": "aisvc:knowledgebase:18e6bbd5-e364-4411-b2c4-eb0cc9a28037", "_textSize": null, "_vectorizedMessage": "", "_metadata": { "_createdAt": "1754559683237", "_updatedById": "df24e92d-17f5-484d-b7e6-b4581fde4038", "_createdById": "df24e92d-17f5-484d-b7e6-b4581fde4038", "_updatedAt": "1754559683237" } }, { "_id": "5a578632-9125-4155-b816-dde3fac2ece9", "_name": "warranty_info", "_fileId": "fedce0e5-7583-43a5-9886-0b14679b1608", "_fileVersionId": "fd3d8988-6366-4577-bf36-926bb5e02b26", "_vectorizedStatus": "VECTORIZED", "_userType": "warranty_info", "_namespaces": [ "testproject_Lik2UwIN" ], "_irn": "aisvc:knowledgebase:5a578632-9125-4155-b816-dde3fac2ece9", "_textSize": null, "_vectorizedMessage": "", "_metadata": { "_createdAt": "1754550888883", "_updatedById": "df24e92d-17f5-484d-b7e6-b4581fde4038", "_createdById": "df24e92d-17f5-484d-b7e6-b4581fde4038", "_updatedAt": "1754550888883" } } ], "_offset": 0, "_pageSize": 2, "_total": 2}Create knowledge base#
Endpoints#
POST aisvc/api/v1/knowledgebasesRequest#
Request body#
| Parameter | Type | Description | Required |
|---|---|---|---|
_name | String | Name of the knowledge base | Required |
_fileId | String | Source file id stored in file service | Required |
_fileVersionId | String | Version id of the file | Required |
_userType | String | User type identifier for the knowledge base | Required |
_namespaces | Array of String | Namespaces associated with the knowledge base | Required |
Request body example#
{ "_name": "warranty_documents", "_userType": "warranty_documents1", "_namespaces": [ "testproject_Lik2UwIN" ], "_fileId": "067ca549-81ef-488a-8a6b-51a2781e2cb0", "_fileVersionId": "43ec6eb5-e440-48f1-b5e5-ba1dd251abbf"}Response#
Codes#
| Code | Description |
|---|---|
200 | Success |
400 | Bad Request |
404 | Not Found |
Response body#
{ "_list": [ { "_id": "71934e96-1354-417c-af1b-5a000d8fbc5e", "_name": "warranty_documents", "_fileId": "067ca549-81ef-488a-8a6b-51a2781e2cb0", "_fileVersionId": "43ec6eb5-e440-48f1-b5e5-ba1dd251abbf", "_vectorizedStatus": "PENDING", "_userType": "warranty_documents1", "_namespaces": [ "testproject_Lik2UwIN" ], "_irn": "aisvc:knowledgebase:71934e96-1354-417c-af1b-5a000d8fbc5e", "_metadata": { "_createdAt": 1757750177372, "_updatedById": "df24e92d-17f5-484d-b7e6-b4581fde4038", "_createdById": "df24e92d-17f5-484d-b7e6-b4581fde4038", "_updatedAt": 1757750177372 } } ], "_offset": 0, "_pageSize": 1, "_total": 1}Get knowledge base by ID#
Endpoints#
GET aisvc/api/v1/knowledgebases/{id}Response#
Codes#
| Code | Description |
|---|---|
200 | Success |
400 | Bad Request |
404 | Not Found |
Response body#
{ "_id": "5a578632-9125-4155-b816-dde3fac2ece9", "_name": "warranty_info", "_fileId": "fedce0e5-7583-43a5-9886-0b14679b1608", "_fileVersionId": "fd3d8988-6366-4577-bf36-926bb5e02b26", "_vectorizedStatus": "VECTORIZED", "_userType": "warranty_info", "_namespaces": [ "testproject_Lik2UwIN" ], "_irn": "aisvc:knowledgebase:5a578632-9125-4155-b816-dde3fac2ece9", "_textSize": null, "_vectorizedMessage": "", "_metadata": { "_createdAt": "1754550888883", "_updatedById": "df24e92d-17f5-484d-b7e6-b4581fde4038", "_createdById": "df24e92d-17f5-484d-b7e6-b4581fde4038", "_updatedAt": "1754550888883" } }Update knowledge base by ID#
Endpoints#
PUT aisvc/api/v1/knowledgebases/{id}Request#
Request body#
| Parameter | Type | Description | Required |
|---|---|---|---|
_name | String | Name of the knowledge base | Required |
_fileId | String | Source file id stored in file service | Required |
_fileVersionId | String | Version id of the file | Required |
_userType | String | User type identifier for the knowledge base | Required |
_namespaces | Array of String | Namespaces associated with the knowledge base | Required |
Request body example#
{ "_name": "warranty_info", "_fileId": "fedce0e5-7583-43a5-9886-0b14679b1608", "_fileVersionId": "fd3d8988-6366-4577-bf36-926bb5e02b26", "_userType": "warranty_info", "_namespaces": [ "testproject_Lik2UwIN" ] }Response#
Codes#
| Code | Description |
|---|---|
200 | Success |
400 | Bad Request |
404 | Not Found |
Response body#
{ "_id": "5a578632-9125-4155-b816-dde3fac2ece9", "_name": "warranty_info", "_fileId": "fedce0e5-7583-43a5-9886-0b14679b1608", "_fileVersionId": "fd3d8988-6366-4577-bf36-926bb5e02b26", "_vectorizedStatus": "VECTORIZED", "_userType": "warranty_info", "_namespaces": [ "testproject_Lik2UwIN" ], "_irn": "aisvc:knowledgebase:5a578632-9125-4155-b816-dde3fac2ece9", "_textSize": null, "_vectorizedMessage": "", "_metadata": { "_createdAt": "1754550888883", "_updatedById": "df24e92d-17f5-484d-b7e6-b4581fde4038", "_createdById": "df24e92d-17f5-484d-b7e6-b4581fde4038", "_updatedAt": "1754550888883" } }Delete knowledge base by ID#
Endpoints#
DELETE aisvc/api/v1/knowledgebases/{id}Response#
Codes#
| Code | Description |
|---|---|
200 | Success |
400 | Bad Request |
404 | Not Found |
Response body#
// empty response body