Scale API

Knowledge Base Data Sources

knowledge_base_data_sources

Methods

Create Knowledge Base Data Source ->
KnowledgeBaseDataSource
post/v4/knowledge-base-data-sources

Description

Creates a knowledge base data source

Details

This API can be used to create a knowledge base data source. To use this API, review the request schema and pass in all fields that are required to create a knowledge base data source.

Delete Knowledge Base Data Source ->
GenericDeleteResponse
delete/v4/knowledge-base-data-sources/{knowledge_base_data_source_id}

Description

Deletes a knowledge base data source

Details

This API can be used to delete a knowledge base data source by ID. To use this API, pass in the id that was returned from your Create Knowledge Base Data Source API call as a path parameter.

List Knowledge Base Data Sources -> PageResponse<
KnowledgeBaseDataSource
>
get/v4/knowledge-base-data-sources

Description

Lists all knowledge base data sources accessible to the user.

Details

This API can be used to list knowledge base data sources. If a user has access to multiple accounts, all knowledge base data sources from all accounts the user is associated with will be returned.

Get Knowledge Base Data Source ->
KnowledgeBaseDataSource
get/v4/knowledge-base-data-sources/{knowledge_base_data_source_id}

Description

Gets the details of a knowledge base data source

Details

This API can be used to get information about a single knowledge base data source by ID. To use this API, pass in the id that was returned from your Create Knowledge Base Data Source API call as a path parameter.

Review the response schema to see the fields that will be returned.

Update Knowledge Base Data Source ->
KnowledgeBaseDataSource
patch/v4/knowledge-base-data-sources/{knowledge_base_data_source_id}

Description

Updates a knowledge base data source

Details

This API can be used to update the knowledge base data source that matches the ID that was passed in as a path parameter. To use this API, pass in the id that was returned from your Create Knowledge Base Data Source API call as a path parameter.

Review the request schema to see the fields that can be updated.

Test Knowledge Base Data Source Credentials -> unknown
post/v4/knowledge-base-data-sources/{knowledge_base_data_source_id}/verify

Test Knowledge Base Data Source credentials

Domain types

AzureBlobStorageDataSourceAuthConfig = { blob_sas_token, source, encrypted }
AzureBlobStorageDataSourceConfig = { container_url, source }
ConfluenceDataSourceAuthConfig = { api_key, atlassian_domain, client_email, 2 more... }
ConfluenceDataSourceConfig = { source, space_key }
GoogleDriveDataSourceAuthConfig = { client_email, client_id, private_key, 3 more... }
GoogleDriveDataSourceConfig = { drive_id, source }
KnowledgeBaseDataSource = { id, account_id, created_at, 6 more... }
LocalChunksSourceConfig = { artifact_name, artifact_uri, source, 1 more... }
LocalFileSourceConfig = { source, deduplication_strategy }
PaginatedKnowledgeBaseDataSources = { current_page, items, items_per_page, 1 more... }
S3DataSourceAuthConfig = { source, encrypted, external_id, 1 more... }
S3DataSourceConfig = { aws_account_id, aws_region, s3_bucket, 2 more... }
SharePointDataSourceAuthConfig = { client_secret, source, encrypted }
SharePointDataSourceConfig = { client_id, site_id, source, 3 more... }
SlackDataSourceAuthConfig = { bot_token, source, encrypted }
SlackDataSourceConfig = { channel_id, source }