List Linkable Data Sources For Knowledge Base

List Linkable Data Sources For Knowledge Base
List data sources linkable to a knowledge base.

This method allows you to list all data sources for a specific knowledge base.

This method is useful if you want to list all data sources or only those that are not yet linked to the specific knowledge base. If exclude_linked is set to true, it will only list data sources that are not currently linked to the specified knowledge base.

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

knowledge_base_id

Query Parameters
boolean
exclude_linked
Optional
Constraints: default: false

exclude_linked

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 LinkableDataSourceListResponse of type(s) application/json 
{
    "object": "string",
    "has_more": false,
    "num_objects": 0,
    "data": [
        {
            "id": "string",
            "origin_url": "string",
            "name": "string",
            "description": "string",
            "type": "string",
            "object": "string",
            "created_at": 0,
            "last_updated_at": 0,
            "options": {
                "bucket": "string",
                "prefix": "string",
                "service_name": "string",
                "api_version": "string",
                "num_results": 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 linkable data sources.

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 knowledge base 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 
{
    "detail": [
        {
            "loc": [
                {}
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
array of object
detail
Optional

detail


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/v1/control/knowledge-bases/{knowledge_base_id}/linkable-data-sources
On This Page
Knowledge Bases Operations
GET
Get Knowledge Base
PATCH
Update Knowledge Base
DELETE
Delete Knowledge Base
GET
List Knowledge Bases
POST
Create Knowledge Base
POST
Clone Knowledge Base
GET
List Linkable Data Sources For Knowledge Base
GET
Get Knowledge Base Data Source Link
DELETE
Delete Knowledge Base Data Source Link
GET
List Knowledge Base Data Source Links
POST
Create Knowledge Base Data Source Link
POST
Cancel Delete Knowledge Base Data Source Link
POST
Batch Create Knowledge Base Data Source Links
POST
Batch Delete Knowledge Base Data Source Links
POST
Batch Cancel Delete Knowledge Base Data Source Links