Knowledge base

List all knowledge base entries

Returns a list of all knowledge base entries belonging to a replica. This endpoint allows you to view all your training data in one place, with optional filtering by status or type. You can use this to monitor the overall state of a replica's knowledge base, check which entries are still processing, and identify any that might have encountered errors. The response includes detailed information about each entry including its content, status, and metadata.

get/v1/replicas/{replicaUUID}/knowledge-base

Request

Base URL: https://api.sensay.io
URL: https://api.sensay.io/v1/replicas/{replicaUUID}/knowledge-base
Auth: none declared

Path parameters

replicaUUIDstring uuid required

The replica unique identifier (UUID)

Example:03db5651-cb61-4bdf-9ef0-89561f7c9c53

Query parameters

statusstring[] nullable

Filter knowledge base entries by comma separated list of their processing statuses. Use this to find entries in specific states like NEW or READY.

[
  "VECTOR_CREATED",
  "READY"
]

typestring[] nullable

Filter knowledge base entries by their content type. Use this to find specific types of training data like text or file uploads.

[
  "website",
  "youtube"
]

searchstring

Filter knowledge base entries by their title, filename, or URL.

Example:Company Policies

hasError'true' | 'false'

Filter knowledge base entries that have encountered errors during processing.

pageinteger

Page number for pagination. Use this to navigate through large result sets.

Example:2

pageSizeinteger nullable

Maximum number of entries to return per page (up to 100). Use this to control result set size. A value of zero can be used to check the total number of items without returning any items.

Example:24

sortBy'createdAt'

Sort criteria.

Example:createdAt

sortOrder'asc' | 'desc'

The order of the sort.

Example:asc

Headers

X-API-Versionstring

Example:2025-03-25

Response

List of knowledge base entries returned successfully.

successboolean required

Indicates if the list operation was successful

totalinteger required

The total number of knowledge base entries.

Example response

{
  "success": true,
  "items": [
    {
      "id": 12345,
      "replicaUUID": "03db5651-cb61-4bdf-9ef0-89561f7c9c53",
      "type": "text",
      "status": "READY",
      "createdAt": "2025-04-15T08:11:00.093761+00:00",
      "updatedAt": "2025-04-15T08:11:05.299349+00:00",
      "title": "Company information",
      "summary": "Basic company details and policies"
    }
  ],
  "total": 100
}

Changes

No recorded changes to this operation across all 1 revision of this API.