Skip to main content
GET
/
v4
/
knowledge-base-data-sources
/
{knowledge_base_data_source_id}
JavaScript
import SGPClient from 'sgp';

const client = new SGPClient({
  apiKey: 'My API Key',
});

const knowledgeBaseDataSource = await client.knowledgeBaseDataSources.retrieve(
  'knowledge_base_data_source_id',
);

console.log(knowledgeBaseDataSource.id);
{
  "name": "<string>",
  "data_source_config": {
    "source": "<string>",
    "s3_bucket": "<string>",
    "aws_region": "<string>",
    "aws_account_id": "<string>",
    "s3_prefix": ""
  },
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "created_by_user_id": "<string>",
  "created_by_identity_type": "user",
  "account_id": "<string>",
  "description": "<string>",
  "tagging_information": {
    "type": "all",
    "tags_to_apply": {}
  }
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
knowledge_base_data_source_id
string
required

Response

Successful Response

​
name
string
required
​
data_source_config
S3 DataSource Config · object
required
  • S3 DataSource Config
  • SharePoint DataSource Config
  • SharePoint Page DataSource Config
  • Google Drive DataSource Config
  • Azure Blob Storage DataSource Config
  • Confluence DataSource Config
  • Slack DataSource Config
  • Snowflake DataSource Config
  • Databricks DataSource Config
​
id
string
required

The unique identifier of the entity.

​
created_at
string<date-time>
required

The date and time when the entity was created in ISO format.

​
updated_at
string<date-time>
required

The date and time when the entity was last updated in ISO format.

​
created_by_user_id
string
required

The user who originally created the entity.

​
created_by_identity_type
enum<string>
required

The type of identity that created the entity.

Available options:
user,
service_account
​
account_id
string
required

The ID of the account that owns the given entity.

​
description
string
​
tagging_information
TaggingInformationAll · object