List Knowledge Bases Linked To Data Source

List Knowledge Bases Linked To Data Source

This method allows you to list all knowledge bases linked to a specific data source.

This method is useful if you want to understand which knowledge bases are using a data source - for example, to understand which knowledge bases are referencing a data source and need to be unlinked in order to allow deletion.

Request
URI
GET
https://{api_host}/api/v1/control/data-sources/{data_source_id}/knowledge-bases
COPY
Path Parameters
string
data_source_id
Required

data_source_id

Query Parameters
string
after
Optional

after

string
before
Optional

before

integer
limit
Optional
Constraints: exclusiveMinimum: 0 exclusiveMaximum: 1000 default: 100

limit

integer
offset
Optional
Constraints: minimum: 0 maximum: 4294967296 default: 0

offset

string
order
Optional
Constraints: default: asc

order

Possible values are : asc, desc,
boolean
set_num_objects
Optional
Constraints: default: false

set_num_objects

string
name
Optional

name

Authentication
This operation uses the following authentication methods.
Responses
200

Successful Response

Returns LinkedKnowledgeBaseListResponse of type(s) application/json 
{
    "object": "string",
    "has_more": false,
    "num_objects": 0,
    "data": [
        {
            "id": "string",
            "state": "string",
            "knowledge_base": {
                "id": "string",
                "name": "string",
                "description": "string",
                "data_origin_type": "string",
                "object": "string",
                "created_at": 0,
                "last_updated_at": 0,
                "next_index_refresh_at": 0
            }
        }
    ],
    "first_id": "string",
    "last_id": "string"
}
string
object
Optional
Constraints: default: list

Object type, which is always list.

boolean
has_more
Optional

True, if the server may have more objects than returned in the response.

integer
num_objects
Required

Total number of objects that match the request. Note that this field is populated only if requested by the user (see set_num_objects request parameter).

array of object
data
Required

List of knowledge bases linked to a data source.

string As uuid As uuid
first_id
Required

ID of the first element in the list (if any)

string As uuid As uuid
last_id
Required

ID of the last element in the list (if any)


404

Invalid data source ID.

Operation doesn't return any data structure

410

An invalid ID was passed for paginating results.

Operation doesn't return any data structure

422

Validation Error

Returns HTTPValidationError of type(s) application/json 
"HTTPValidationError Object"
array of object
detail
Optional

detail


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/v1/control/data-sources/{data_source_id}/knowledge-bases
On This Page
Data Sources Operations
GET
Test Data Source Configuration
POST
Test Connectivity
GET
List Data Sources
POST
Create Data Source
GET
Get Data Source
PATCH
Update Data Source
DELETE
Delete Data Source
GET
List Knowledge Bases Linked To Data Source