Skip to content
DigitalOcean Gradient™ AI Agentic Cloud SDK Docs
  • Auto
  • Light
  • Dark

List

API Reference
Knowledge Bases
Data Sources
List Data Sources for a Knowledge Base
knowledge_bases.data_sources.list(strknowledge_base_uuid, DataSourceListParams**kwargs) -> DataSourceListResponse
get/v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources

To list all data sources for a knowledge base, send a GET request to /v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources.

ParametersExpand Collapse
knowledge_base_uuid: str
page: Optional[int]

Page number.

per_page: Optional[int]

Items per page.

ReturnsExpand Collapse
class DataSourceListResponse: …

A list of knowledge base data sources

knowledge_base_data_sources: Optional[List[APIKnowledgeBaseDataSource]]

The data sources

aws_data_source: Optional[AwsDataSource]

AWS S3 Data Source for Display

bucket_name: Optional[str]

Spaces bucket name

item_path: Optional[str]
region: Optional[str]

Region of bucket

bucket_name: Optional[str]

Name of storage bucket - Deprecated, moved to data_source_details

created_at: Optional[datetime]

Creation date / time

formatdate-time
dropbox_data_source: Optional[DropboxDataSource]

Dropbox Data Source for Display

folder: Optional[str]
file_upload_data_source: Optional[APIFileUploadDataSource]

File to upload as data source for knowledge base.

item_path: Optional[str]

Path of folder or object in bucket - Deprecated, moved to data_source_details

last_datasource_indexing_job: Optional[APIIndexedDataSource]
last_indexing_job: Optional[APIIndexingJob]

IndexingJob description

region: Optional[str]

Region code - Deprecated, moved to data_source_details

spaces_data_source: Optional[APISpacesDataSource]

Spaces Bucket Data Source

updated_at: Optional[datetime]

Last modified

formatdate-time
uuid: Optional[str]

Unique id of knowledge base

web_crawler_data_source: Optional[APIWebCrawlerDataSource]

WebCrawlerDataSource

Links to other pages

meta: Optional[APIMeta]

Meta information about the data set

from gradient import Gradient

client = Gradient()
data_sources = client.knowledge_bases.data_sources.list(
    knowledge_base_uuid="\"123e4567-e89b-12d3-a456-426614174000\"",
)
print(data_sources.knowledge_base_data_sources)
{
  "knowledge_base_data_sources": [
    {
      "aws_data_source": {
        "bucket_name": "example name",
        "item_path": "example string",
        "region": "example string"
      },
      "bucket_name": "example name",
      "created_at": "2023-01-01T00:00:00Z",
      "dropbox_data_source": {
        "folder": "example string"
      },
      "file_upload_data_source": {
        "original_file_name": "example name",
        "size_in_bytes": "12345",
        "stored_object_key": "example string"
      },
      "item_path": "example string",
      "last_datasource_indexing_job": {
        "completed_at": "2023-01-01T00:00:00Z",
        "data_source_uuid": "123e4567-e89b-12d3-a456-426614174000",
        "error_details": "example string",
        "error_msg": "example string",
        "failed_item_count": "12345",
        "indexed_file_count": "12345",
        "indexed_item_count": "12345",
        "removed_item_count": "12345",
        "skipped_item_count": "12345",
        "started_at": "2023-01-01T00:00:00Z",
        "status": "DATA_SOURCE_STATUS_UNKNOWN",
        "total_bytes": "12345",
        "total_bytes_indexed": "12345",
        "total_file_count": "12345"
      },
      "last_indexing_job": {
        "completed_datasources": 123,
        "created_at": "2023-01-01T00:00:00Z",
        "data_source_uuids": [
          "example string"
        ],
        "finished_at": "2023-01-01T00:00:00Z",
        "knowledge_base_uuid": "123e4567-e89b-12d3-a456-426614174000",
        "phase": "BATCH_JOB_PHASE_UNKNOWN",
        "started_at": "2023-01-01T00:00:00Z",
        "status": "INDEX_JOB_STATUS_UNKNOWN",
        "tokens": 123,
        "total_datasources": 123,
        "total_items_failed": "12345",
        "total_items_indexed": "12345",
        "total_items_skipped": "12345",
        "updated_at": "2023-01-01T00:00:00Z",
        "uuid": "123e4567-e89b-12d3-a456-426614174000"
      },
      "region": "example string",
      "spaces_data_source": {
        "bucket_name": "example name",
        "item_path": "example string",
        "region": "example string"
      },
      "updated_at": "2023-01-01T00:00:00Z",
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "web_crawler_data_source": {
        "base_url": "example string",
        "crawling_option": "UNKNOWN",
        "embed_media": true
      }
    }
  ],
  "links": {
    "pages": {
      "first": "example string",
      "last": "example string",
      "next": "example string",
      "previous": "example string"
    }
  },
  "meta": {
    "page": 123,
    "pages": 123,
    "total": 123
  }
}
Returns Examples
{
  "knowledge_base_data_sources": [
    {
      "aws_data_source": {
        "bucket_name": "example name",
        "item_path": "example string",
        "region": "example string"
      },
      "bucket_name": "example name",
      "created_at": "2023-01-01T00:00:00Z",
      "dropbox_data_source": {
        "folder": "example string"
      },
      "file_upload_data_source": {
        "original_file_name": "example name",
        "size_in_bytes": "12345",
        "stored_object_key": "example string"
      },
      "item_path": "example string",
      "last_datasource_indexing_job": {
        "completed_at": "2023-01-01T00:00:00Z",
        "data_source_uuid": "123e4567-e89b-12d3-a456-426614174000",
        "error_details": "example string",
        "error_msg": "example string",
        "failed_item_count": "12345",
        "indexed_file_count": "12345",
        "indexed_item_count": "12345",
        "removed_item_count": "12345",
        "skipped_item_count": "12345",
        "started_at": "2023-01-01T00:00:00Z",
        "status": "DATA_SOURCE_STATUS_UNKNOWN",
        "total_bytes": "12345",
        "total_bytes_indexed": "12345",
        "total_file_count": "12345"
      },
      "last_indexing_job": {
        "completed_datasources": 123,
        "created_at": "2023-01-01T00:00:00Z",
        "data_source_uuids": [
          "example string"
        ],
        "finished_at": "2023-01-01T00:00:00Z",
        "knowledge_base_uuid": "123e4567-e89b-12d3-a456-426614174000",
        "phase": "BATCH_JOB_PHASE_UNKNOWN",
        "started_at": "2023-01-01T00:00:00Z",
        "status": "INDEX_JOB_STATUS_UNKNOWN",
        "tokens": 123,
        "total_datasources": 123,
        "total_items_failed": "12345",
        "total_items_indexed": "12345",
        "total_items_skipped": "12345",
        "updated_at": "2023-01-01T00:00:00Z",
        "uuid": "123e4567-e89b-12d3-a456-426614174000"
      },
      "region": "example string",
      "spaces_data_source": {
        "bucket_name": "example name",
        "item_path": "example string",
        "region": "example string"
      },
      "updated_at": "2023-01-01T00:00:00Z",
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "web_crawler_data_source": {
        "base_url": "example string",
        "crawling_option": "UNKNOWN",
        "embed_media": true
      }
    }
  ],
  "links": {
    "pages": {
      "first": "example string",
      "last": "example string",
      "next": "example string",
      "previous": "example string"
    }
  },
  "meta": {
    "page": 123,
    "pages": 123,
    "total": 123
  }
}