Data Sources

API Reference

Knowledge Bases

Data Sources

Add Data Source to a Knowledge Base

post/v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources

Delete a Data Source from a Knowledge Base

delete/v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources/{data_source_uuid}

List Data Sources for a Knowledge Base

get/v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources

ModelsExpand Collapse

APIFileUploadDataSource = object { original_file_name, size_in_bytes, stored_object_key }

File to upload as data source for knowledge base.

original_file_name: optional string

The original file name

size_in_bytes: optional string

The size of the file in bytes

formatuint64

stored_object_key: optional string

The object key the file was stored as

APIKnowledgeBaseDataSource = object { aws_data_source, bucket_name, created_at, 10 more }

Data Source configuration for Knowledge Bases

aws_data_source: optional object { bucket_name, item_path, region }

AWS S3 Data Source for Display

bucket_name: optional string

Spaces bucket name

item_path: optional string

region: optional string

Region of bucket

bucket_name: optional string

Name of storage bucket - Deprecated, moved to data_source_details

created_at: optional string

Creation date / time

formatdate-time

dropbox_data_source: optional object { folder }

Dropbox Data Source for Display

folder: optional string

file_upload_data_source: optional APIFileUploadDataSource

File to upload as data source for knowledge base.

item_path: optional string

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 string

Region code - Deprecated, moved to data_source_details

spaces_data_source: optional APISpacesDataSource

Spaces Bucket Data Source

updated_at: optional string

Last modified

formatdate-time

uuid: optional string

Unique id of knowledge base

web_crawler_data_source: optional APIWebCrawlerDataSource

WebCrawlerDataSource

APISpacesDataSource = object { bucket_name, item_path, region }

Spaces Bucket Data Source

bucket_name: optional string

Spaces bucket name

item_path: optional string

region: optional string

Region of bucket

APIWebCrawlerDataSource = object { base_url, crawling_option, embed_media }

WebCrawlerDataSource

base_url: optional string

The base url to crawl.

crawling_option: optional "UNKNOWN" or "SCOPED" or "PATH" or 2 more

Options for specifying how URLs found on pages should be handled.

• UNKNOWN: Default unknown value
• SCOPED: Only include the base URL.
• PATH: Crawl the base URL and linked pages within the URL path.
• DOMAIN: Crawl the base URL and linked pages within the same domain.
• SUBDOMAINS: Crawl the base URL and linked pages for any subdomain.

Accepts one of the following:

"UNKNOWN"

"SCOPED"

"PATH"

"DOMAIN"

"SUBDOMAINS"

embed_media: optional boolean

Whether to ingest and index media (images, etc.) on web pages.

AwsDataSource = object { bucket_name, item_path, key_id, 2 more }

AWS S3 Data Source

bucket_name: optional string

Spaces bucket name

item_path: optional string

key_id: optional string

The AWS Key ID

region: optional string

Region of bucket

secret_key: optional string

The AWS Secret Key