Knowledge Bases

API Reference

Knowledge Bases

Create a Knowledge Base

client.knowledgeBases.create(KnowledgeBaseCreateParams { database_id, datasources, embedding_model_uuid, 5 more } body?, RequestOptionsoptions?): KnowledgeBaseCreateResponse { knowledge_base }

post/v2/gen-ai/knowledge_bases

Delete a Knowledge Base

client.knowledgeBases.delete(stringuuid, RequestOptionsoptions?): KnowledgeBaseDeleteResponse { uuid }

delete/v2/gen-ai/knowledge_bases/{uuid}

List Knowledge Bases

client.knowledgeBases.list(KnowledgeBaseListParams { page, per_page } query?, RequestOptionsoptions?): KnowledgeBaseListResponse { knowledge_bases, links, meta }

get/v2/gen-ai/knowledge_bases

Retrieve Information About an Existing Knowledge Base

client.knowledgeBases.retrieve(stringuuid, RequestOptionsoptions?): KnowledgeBaseRetrieveResponse { database_status, knowledge_base }

get/v2/gen-ai/knowledge_bases/{uuid}

Update a Knowledge Base

client.knowledgeBases.update(stringpathUuid, KnowledgeBaseUpdateParams { database_id, embedding_model_uuid, name, 3 more } body?, RequestOptionsoptions?): KnowledgeBaseUpdateResponse { knowledge_base }

put/v2/gen-ai/knowledge_bases/{uuid}

ModelsExpand Collapse

APIKnowledgeBase { added_to_agent_at, created_at, database_id, 10 more }

Knowledgebase Description

added_to_agent_at?: string

Time when the knowledge base was added to the agent

formatdate-time

created_at?: string

Creation date / time

formatdate-time

database_id?: string

embedding_model_uuid?: string

is_public?: boolean

Whether the knowledge base is public or not

last_indexing_job?: APIIndexingJob { completed_datasources, created_at, data_source_uuids, 12 more }

IndexingJob description

completed_datasources?: number

Number of datasources indexed completed

formatint64

created_at?: string

Creation date / time

formatdate-time

data_source_uuids?: Array<string>

finished_at?: string

knowledge_base_uuid?: string

Knowledge base id

phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more

Accepts one of the following:

"BATCH_JOB_PHASE_UNKNOWN"

"BATCH_JOB_PHASE_PENDING"

"BATCH_JOB_PHASE_RUNNING"

"BATCH_JOB_PHASE_SUCCEEDED"

"BATCH_JOB_PHASE_FAILED"

"BATCH_JOB_PHASE_ERROR"

"BATCH_JOB_PHASE_CANCELLED"

started_at?: string

status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more

Accepts one of the following:

"INDEX_JOB_STATUS_UNKNOWN"

"INDEX_JOB_STATUS_PARTIAL"

"INDEX_JOB_STATUS_IN_PROGRESS"

"INDEX_JOB_STATUS_COMPLETED"

"INDEX_JOB_STATUS_FAILED"

"INDEX_JOB_STATUS_NO_CHANGES"

"INDEX_JOB_STATUS_PENDING"

tokens?: number

Number of tokens

formatint64

total_datasources?: number

Number of datasources being indexed

formatint64

total_items_failed?: string

Total Items Failed

formatuint64

total_items_indexed?: string

Total Items Indexed

formatuint64

total_items_skipped?: string

Total Items Skipped

formatuint64

updated_at?: string

Last modified

formatdate-time

uuid?: string

Unique id

name?: string

Name of knowledge base

project_id?: string

region?: string

Region code

tags?: Array<string>

Tags to organize related resources

updated_at?: string

Last modified

formatdate-time

user_id?: string

Id of user that created the knowledge base

formatint64

uuid?: string

Unique id for knowledge base

Knowledge BasesData Sources

Add Data Source to a Knowledge Base

client.knowledgeBases.dataSources.create(stringknowledgeBaseUuid, DataSourceCreateParams { aws_data_source, knowledge_base_uuid, spaces_data_source, web_crawler_data_source } body?, RequestOptionsoptions?): DataSourceCreateResponse { knowledge_base_data_source }

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

Create Presigned URLs for Data Source File Upload

client.knowledgeBases.dataSources.createPresignedURLs(DataSourceCreatePresignedURLsParams { files } body?, RequestOptionsoptions?): DataSourceCreatePresignedURLsResponse { request_id, uploads }

post/v2/gen-ai/knowledge_bases/data_sources/file_upload_presigned_urls

Delete a Data Source from a Knowledge Base

client.knowledgeBases.dataSources.delete(stringdataSourceUuid, DataSourceDeleteParams { knowledge_base_uuid } params, RequestOptionsoptions?): DataSourceDeleteResponse { data_source_uuid, knowledge_base_uuid }

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

List Data Sources for a Knowledge Base

client.knowledgeBases.dataSources.list(stringknowledgeBaseUuid, DataSourceListParams { page, per_page } query?, RequestOptionsoptions?): DataSourceListResponse { knowledge_base_data_sources, links, meta }

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

ModelsExpand Collapse

APIFileUploadDataSource { original_file_name, size_in_bytes, stored_object_key }

File to upload as data source for knowledge base.

original_file_name?: string

The original file name

size_in_bytes?: string

The size of the file in bytes

formatuint64

stored_object_key?: string

The object key the file was stored as

APIKnowledgeBaseDataSource { aws_data_source, bucket_name, created_at, 10 more }

Data Source configuration for Knowledge Bases

aws_data_source?: AwsDataSource { bucket_name, item_path, region }

AWS S3 Data Source for Display

bucket_name?: string

Spaces bucket name

item_path?: string

region?: string

Region of bucket

bucket_name?: string

Name of storage bucket - Deprecated, moved to data_source_details

created_at?: string

Creation date / time

formatdate-time

dropbox_data_source?: DropboxDataSource { folder }

Dropbox Data Source for Display

folder?: string

file_upload_data_source?: APIFileUploadDataSource { original_file_name, size_in_bytes, stored_object_key }

File to upload as data source for knowledge base.

original_file_name?: string

The original file name

size_in_bytes?: string

The size of the file in bytes

formatuint64

stored_object_key?: string

The object key the file was stored as

item_path?: string

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

last_datasource_indexing_job?: APIIndexedDataSource { completed_at, data_source_uuid, error_details, 11 more }

completed_at?: string

Timestamp when data source completed indexing

formatdate-time

data_source_uuid?: string

Uuid of the indexed data source

error_details?: string

A detailed error description

error_msg?: string

A string code provinding a hint which part of the system experienced an error

failed_item_count?: string

Total count of files that have failed

formatuint64

indexed_file_count?: string

Total count of files that have been indexed

formatuint64

indexed_item_count?: string

Total count of files that have been indexed

formatuint64

removed_item_count?: string

Total count of files that have been removed

formatuint64

skipped_item_count?: string

Total count of files that have been skipped

formatuint64

started_at?: string

Timestamp when data source started indexing

formatdate-time

status?: "DATA_SOURCE_STATUS_UNKNOWN" | "DATA_SOURCE_STATUS_IN_PROGRESS" | "DATA_SOURCE_STATUS_UPDATED" | 3 more

Accepts one of the following:

"DATA_SOURCE_STATUS_UNKNOWN"

"DATA_SOURCE_STATUS_IN_PROGRESS"

"DATA_SOURCE_STATUS_UPDATED"

"DATA_SOURCE_STATUS_PARTIALLY_UPDATED"

"DATA_SOURCE_STATUS_NOT_UPDATED"

"DATA_SOURCE_STATUS_FAILED"

total_bytes?: string

Total size of files in data source in bytes

formatuint64

total_bytes_indexed?: string

Total size of files in data source in bytes that have been indexed

formatuint64

total_file_count?: string

Total file count in the data source

formatuint64

last_indexing_job?: APIIndexingJob { completed_datasources, created_at, data_source_uuids, 12 more }

IndexingJob description

completed_datasources?: number

Number of datasources indexed completed

formatint64

created_at?: string

Creation date / time

formatdate-time

data_source_uuids?: Array<string>

finished_at?: string

knowledge_base_uuid?: string

Knowledge base id

phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more

Accepts one of the following:

"BATCH_JOB_PHASE_UNKNOWN"

"BATCH_JOB_PHASE_PENDING"

"BATCH_JOB_PHASE_RUNNING"

"BATCH_JOB_PHASE_SUCCEEDED"

"BATCH_JOB_PHASE_FAILED"

"BATCH_JOB_PHASE_ERROR"

"BATCH_JOB_PHASE_CANCELLED"

started_at?: string

status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more

Accepts one of the following:

"INDEX_JOB_STATUS_UNKNOWN"

"INDEX_JOB_STATUS_PARTIAL"

"INDEX_JOB_STATUS_IN_PROGRESS"

"INDEX_JOB_STATUS_COMPLETED"

"INDEX_JOB_STATUS_FAILED"

"INDEX_JOB_STATUS_NO_CHANGES"

"INDEX_JOB_STATUS_PENDING"

tokens?: number

Number of tokens

formatint64

total_datasources?: number

Number of datasources being indexed

formatint64

total_items_failed?: string

Total Items Failed

formatuint64

total_items_indexed?: string

Total Items Indexed

formatuint64

total_items_skipped?: string

Total Items Skipped

formatuint64

updated_at?: string

Last modified

formatdate-time

uuid?: string

Unique id

region?: string

Region code - Deprecated, moved to data_source_details

spaces_data_source?: APISpacesDataSource { bucket_name, item_path, region }

Spaces Bucket Data Source

bucket_name?: string

Spaces bucket name

item_path?: string

region?: string

Region of bucket

updated_at?: string

Last modified

formatdate-time

uuid?: string

Unique id of knowledge base

web_crawler_data_source?: APIWebCrawlerDataSource { base_url, crawling_option, embed_media }

WebCrawlerDataSource

base_url?: string

The base url to crawl.

crawling_option?: "UNKNOWN" | "SCOPED" | "PATH" | 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?: boolean

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

APISpacesDataSource { bucket_name, item_path, region }

Spaces Bucket Data Source

bucket_name?: string

Spaces bucket name

item_path?: string

region?: string

Region of bucket

APIWebCrawlerDataSource { base_url, crawling_option, embed_media }

WebCrawlerDataSource

base_url?: string

The base url to crawl.

crawling_option?: "UNKNOWN" | "SCOPED" | "PATH" | 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?: boolean

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

AwsDataSource { bucket_name, item_path, key_id, 2 more }

AWS S3 Data Source

bucket_name?: string

Spaces bucket name

item_path?: string

key_id?: string

The AWS Key ID

region?: string

Region of bucket

secret_key?: string

The AWS Secret Key

Knowledge BasesIndexing Jobs

Start Indexing Job for a Knowledge Base

client.knowledgeBases.indexingJobs.create(IndexingJobCreateParams { data_source_uuids, knowledge_base_uuid } body?, RequestOptionsoptions?): IndexingJobCreateResponse { job }

post/v2/gen-ai/indexing_jobs

List Indexing Jobs for a Knowledge Base

client.knowledgeBases.indexingJobs.list(IndexingJobListParams { page, per_page } query?, RequestOptionsoptions?): IndexingJobListResponse { jobs, links, meta }

get/v2/gen-ai/indexing_jobs

Retrieve Status of Indexing Job for a Knowledge Base

client.knowledgeBases.indexingJobs.retrieve(stringuuid, RequestOptionsoptions?): IndexingJobRetrieveResponse { job }

get/v2/gen-ai/indexing_jobs/{uuid}

List Data Sources for Indexing Job for a Knowledge Base

client.knowledgeBases.indexingJobs.retrieveDataSources(stringindexingJobUuid, RequestOptionsoptions?): IndexingJobRetrieveDataSourcesResponse { indexed_data_sources }

get/v2/gen-ai/indexing_jobs/{indexing_job_uuid}/data_sources

Cancel Indexing Job for a Knowledge Base

client.knowledgeBases.indexingJobs.updateCancel(stringpathUuid, IndexingJobUpdateCancelParams { body_uuid } body?, RequestOptionsoptions?): IndexingJobUpdateCancelResponse { job }

put/v2/gen-ai/indexing_jobs/{uuid}/cancel

ModelsExpand Collapse

APIIndexedDataSource { completed_at, data_source_uuid, error_details, 11 more }

completed_at?: string

Timestamp when data source completed indexing

formatdate-time

data_source_uuid?: string

Uuid of the indexed data source

error_details?: string

A detailed error description

error_msg?: string

A string code provinding a hint which part of the system experienced an error

failed_item_count?: string

Total count of files that have failed

formatuint64

indexed_file_count?: string

Total count of files that have been indexed

formatuint64

indexed_item_count?: string

Total count of files that have been indexed

formatuint64

removed_item_count?: string

Total count of files that have been removed

formatuint64

skipped_item_count?: string

Total count of files that have been skipped

formatuint64

started_at?: string

Timestamp when data source started indexing

formatdate-time

status?: "DATA_SOURCE_STATUS_UNKNOWN" | "DATA_SOURCE_STATUS_IN_PROGRESS" | "DATA_SOURCE_STATUS_UPDATED" | 3 more

Accepts one of the following:

"DATA_SOURCE_STATUS_UNKNOWN"

"DATA_SOURCE_STATUS_IN_PROGRESS"

"DATA_SOURCE_STATUS_UPDATED"

"DATA_SOURCE_STATUS_PARTIALLY_UPDATED"

"DATA_SOURCE_STATUS_NOT_UPDATED"

"DATA_SOURCE_STATUS_FAILED"

total_bytes?: string

Total size of files in data source in bytes

formatuint64

total_bytes_indexed?: string

Total size of files in data source in bytes that have been indexed

formatuint64

total_file_count?: string

Total file count in the data source

formatuint64

APIIndexingJob { completed_datasources, created_at, data_source_uuids, 12 more }

IndexingJob description

completed_datasources?: number

Number of datasources indexed completed

formatint64

created_at?: string

Creation date / time

formatdate-time

data_source_uuids?: Array<string>

finished_at?: string

knowledge_base_uuid?: string

Knowledge base id

phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more

Accepts one of the following:

"BATCH_JOB_PHASE_UNKNOWN"

"BATCH_JOB_PHASE_PENDING"

"BATCH_JOB_PHASE_RUNNING"

"BATCH_JOB_PHASE_SUCCEEDED"

"BATCH_JOB_PHASE_FAILED"

"BATCH_JOB_PHASE_ERROR"

"BATCH_JOB_PHASE_CANCELLED"

started_at?: string

status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 4 more

Accepts one of the following:

"INDEX_JOB_STATUS_UNKNOWN"

"INDEX_JOB_STATUS_PARTIAL"

"INDEX_JOB_STATUS_IN_PROGRESS"

"INDEX_JOB_STATUS_COMPLETED"

"INDEX_JOB_STATUS_FAILED"

"INDEX_JOB_STATUS_NO_CHANGES"

"INDEX_JOB_STATUS_PENDING"

tokens?: number

Number of tokens

formatint64

total_datasources?: number

Number of datasources being indexed

formatint64

total_items_failed?: string

Total Items Failed

formatuint64

total_items_indexed?: string

Total Items Indexed

formatuint64

total_items_skipped?: string

Total Items Skipped

formatuint64

updated_at?: string

Last modified

formatdate-time

uuid?: string

Unique id