API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Data Sources

List Data Sources

client.DataSources.List(ctx, query) (*[]DataSource, error)

GET/api/v1/data-sources

Create Data Source

client.DataSources.New(ctx, params) (*DataSource, error)

POST/api/v1/data-sources

Get Data Source

client.DataSources.Get(ctx, dataSourceID) (*DataSource, error)

GET/api/v1/data-sources/{data_source_id}

Update Data Source

client.DataSources.Update(ctx, dataSourceID, body) (*DataSource, error)

PUT/api/v1/data-sources/{data_source_id}

Delete Data Source

client.DataSources.Delete(ctx, dataSourceID) error

DELETE/api/v1/data-sources/{data_source_id}

ModelsExpand Collapse

type DataSource struct{…}

Schema for a data source.

ID string

Unique identifier

formatuuid

Component DataSourceComponentUnion

Component that implements the data source

One of the following:

type DataSourceComponentMap map[string, any]

type CloudS3DataSource struct{…}

Bucket string

The name of the S3 bucket to read from.

AwsAccessID stringOptional

The AWS access ID to use for authentication.

AwsAccessSecret stringOptional

The AWS access secret to use for authentication.

formatpassword

ClassName stringOptional

Prefix stringOptional

The prefix of the S3 objects to read from.

RegexPattern stringOptional

The regex pattern to filter S3 objects. Must be a valid regex pattern.

S3EndpointURL stringOptional

The S3 endpoint URL to use for authentication.

SupportsAccessControl boolOptional

type CloudAzStorageBlobDataSource struct{…}

AccountURL string

The Azure Storage Blob account URL to use for authentication.

ContainerName string

The name of the Azure Storage Blob container to read from.

AccountKey stringOptional

The Azure Storage Blob account key to use for authentication.

formatpassword

AccountName stringOptional

The Azure Storage Blob account name to use for authentication.

Blob stringOptional

The blob name to read from.

ClassName stringOptional

ClientID stringOptional

The Azure AD client ID to use for authentication.

ClientSecret stringOptional

The Azure AD client secret to use for authentication.

formatpassword

Prefix stringOptional

The prefix of the Azure Storage Blob objects to read from.

SupportsAccessControl boolOptional

TenantID stringOptional

The Azure AD tenant ID to use for authentication.

type CloudGoogleDriveDataSource struct{…}

FolderID string

The ID of the Google Drive folder to read from.

ClassName stringOptional

FolderName stringOptional

Human-readable name of the selected folder, for display.

ServiceAccountKey map[string, string]Optional

A dictionary containing secret values

SupportsAccessControl boolOptional

type CloudOneDriveDataSource struct{…}

ClientID string

The client ID to use for authentication.

ClientSecret string

The client secret to use for authentication.

formatpassword

TenantID string

The tenant ID to use for authentication.

UserPrincipalName string

The user principal name to use for authentication.

ClassName stringOptional

FolderID stringOptional

The ID of the OneDrive folder to read from.

FolderPath stringOptional

The path of the OneDrive folder to read from.

RequiredExts []stringOptional

The list of required file extensions.

SupportsAccessControl boolOptional

type CloudSharepointDataSource struct{…}

ClientID string

The client ID to use for authentication.

ClientSecret string

The client secret to use for authentication.

formatpassword

TenantID string

The tenant ID to use for authentication.

ClassName stringOptional

DriveName stringOptional

The name of the Sharepoint drive to read from.

ExcludePathPatterns []stringOptional

List of regex patterns for file paths to exclude. Files whose paths (including filename) match any pattern will be excluded. Example: [‘/temp/’, ‘/backup/’, ‘.git/’, ‘.tmp$’, ’^~’]

FolderID stringOptional

The ID of the Sharepoint folder to read from.

FolderPath stringOptional

The path of the Sharepoint folder to read from.

GetPermissions boolOptional

Whether to get permissions for the sharepoint site.

IncludePathPatterns []stringOptional

List of regex patterns for file paths to include. Full paths (including filename) must match at least one pattern to be included. Example: [‘/reports/’, ‘/docs/..pdf$’, ‘^Report..pdf$’]

RequiredExts []stringOptional

The list of required file extensions.

SiteID stringOptional

The ID of the SharePoint site to download from.

SiteName stringOptional

The name of the SharePoint site to download from.

SupportsAccessControl boolOptional

type CloudSlackDataSource struct{…}

SlackToken string

Slack Bot Token.

formatpassword

ChannelIDs stringOptional

Slack Channel.

ChannelPatterns stringOptional

Slack Channel name pattern.

ClassName stringOptional

EarliestDate stringOptional

Earliest date.

EarliestDateTimestamp float64Optional

Earliest date timestamp.

LatestDate stringOptional

Latest date.

LatestDateTimestamp float64Optional

Latest date timestamp.

SupportsAccessControl boolOptional

type CloudNotionPageDataSource struct{…}

IntegrationToken string

The integration token to use for authentication.

formatpassword

ClassName stringOptional

DatabaseIDs stringOptional

The Notion Database Id to read content from.

PageIDs stringOptional

The Page ID’s of the Notion to read from.

SupportsAccessControl boolOptional

type CloudConfluenceDataSource struct{…}

AuthenticationMechanism string

Type of Authentication for connecting to Confluence APIs.

ServerURL string

The server URL of the Confluence instance.

APIToken stringOptional

The API token to use for authentication.

formatpassword

ClassName stringOptional

Cql stringOptional

The CQL query to use for fetching pages.

FailureHandling FailureHandlingConfigOptional

Configuration for handling failures during processing. Key-value object controlling failure handling behaviors.

Example: { “skip_list_failures”: true }

Currently supports:

• skip_list_failures: Skip failed batches/lists and continue processing

SkipListFailures boolOptional

Whether to skip failed batches/lists and continue processing

IndexRestrictedPages boolOptional

Whether to index restricted pages.

KeepMarkdownFormat boolOptional

Whether to keep the markdown format.

Label stringOptional

The label to use for fetching pages.

PageIDs stringOptional

The page IDs of the Confluence to read from.

SpaceKey stringOptional

The space key to read from.

SupportsAccessControl boolOptional

SyncPermissions boolOptional

Whether to fetch space-level permissions (allowed users/groups) and attach them to document metadata for access control. Disable for Confluence Server/Data Center versions whose permission APIs are unavailable (e.g. the JSON-RPC API removed in Data Center 9.2.6+), which otherwise surface as 401 errors during sync.

UserName stringOptional

The username to use for authentication.

type CloudJiraDataSource struct{…}

Cloud Jira Data Source integrating JiraReader.

AuthenticationMechanism string

Type of Authentication for connecting to Jira APIs.

Query string

JQL (Jira Query Language) query to search.

APIToken stringOptional

The API/ Access Token used for Basic, PAT and OAuth2 authentication.

formatpassword

ClassName stringOptional

CloudID stringOptional

The cloud ID, used in case of OAuth2.

Email stringOptional

The email address to use for authentication.

ServerURL stringOptional

The server url for Jira Cloud.

SupportsAccessControl boolOptional

type CloudJiraDataSourceV2 struct{…}

Cloud Jira Data Source integrating JiraReaderV2.

AuthenticationMechanism string

Type of Authentication for connecting to Jira APIs.

Query string

JQL (Jira Query Language) query to search.

ServerURL string

The server url for Jira Cloud.

APIToken stringOptional

The API Access Token used for Basic, PAT and OAuth2 authentication.

formatpassword

APIVersion CloudJiraDataSourceV2APIVersionOptional

Jira REST API version to use (2 or 3). 3 supports Atlassian Document Format (ADF).

One of the following:

const CloudJiraDataSourceV2APIVersion2 CloudJiraDataSourceV2APIVersion = "2"

const CloudJiraDataSourceV2APIVersion3 CloudJiraDataSourceV2APIVersion = "3"

ClassName stringOptional

CloudID stringOptional

The cloud ID, used in case of OAuth2.

Email stringOptional

The email address to use for authentication.

Expand stringOptional

Fields to expand in the response.

Fields []stringOptional

List of fields to retrieve from Jira. If None, retrieves all fields.

GetPermissions boolOptional

Whether to fetch project role permissions and issue-level security

RequestsPerMinute int64Optional

Rate limit for Jira API requests per minute.

SupportsAccessControl boolOptional

type CloudBoxDataSource struct{…}

AuthenticationMechanism CloudBoxDataSourceAuthenticationMechanism

The type of authentication to use (Developer Token or CCG)

One of the following:

const CloudBoxDataSourceAuthenticationMechanismCcg CloudBoxDataSourceAuthenticationMechanism = "ccg"

const CloudBoxDataSourceAuthenticationMechanismDeveloperToken CloudBoxDataSourceAuthenticationMechanism = "developer_token"

ClassName stringOptional

ClientID stringOptional

Box API key used for identifying the application the user is authenticating with

ClientSecret stringOptional

Box API secret used for making auth requests.

formatpassword

DeveloperToken stringOptional

Developer token for authentication if authentication_mechanism is ‘developer_token’.

formatpassword

EnterpriseID stringOptional

Box Enterprise ID, if provided authenticates as service.

FolderID stringOptional

The ID of the Box folder to read from.

SupportsAccessControl boolOptional

UserID stringOptional

Box User ID, if provided authenticates as user.

Name string

The name of the data source.

ProjectID string

SourceType DataSourceSourceType

One of the following:

const DataSourceSourceTypeAzureStorageBlob DataSourceSourceType = "AZURE_STORAGE_BLOB"

const DataSourceSourceTypeBox DataSourceSourceType = "BOX"

const DataSourceSourceTypeConfluence DataSourceSourceType = "CONFLUENCE"

const DataSourceSourceTypeGoogleDrive DataSourceSourceType = "GOOGLE_DRIVE"

const DataSourceSourceTypeJira DataSourceSourceType = "JIRA"

const DataSourceSourceTypeJiraV2 DataSourceSourceType = "JIRA_V2"

const DataSourceSourceTypeMicrosoftOnedrive DataSourceSourceType = "MICROSOFT_ONEDRIVE"

const DataSourceSourceTypeMicrosoftSharepoint DataSourceSourceType = "MICROSOFT_SHAREPOINT"

const DataSourceSourceTypeNotionPage DataSourceSourceType = "NOTION_PAGE"

const DataSourceSourceTypeS3 DataSourceSourceType = "S3"

const DataSourceSourceTypeSlack DataSourceSourceType = "SLACK"

CreatedAt TimeOptional

Creation datetime

formatdate-time

CustomMetadata map[string, *DataSourceCustomMetadataUnion]Optional

Custom metadata that will be present on all data loaded from the data source

One of the following:

type DataSourceCustomMetadataMap map[string, any]

type DataSourceCustomMetadataArray []any

string

float64

bool

UpdatedAt TimeOptional

Update datetime

formatdate-time

VersionMetadata DataSourceReaderVersionMetadataOptional

Version metadata for the data source

ReaderVersion DataSourceReaderVersionMetadataReaderVersionOptional

The version of the reader to use for this data source.

One of the following:

const DataSourceReaderVersionMetadataReaderVersion1_0 DataSourceReaderVersionMetadataReaderVersion = "1.0"

const DataSourceReaderVersionMetadataReaderVersion2_0 DataSourceReaderVersionMetadataReaderVersion = "2.0"

const DataSourceReaderVersionMetadataReaderVersion2_1 DataSourceReaderVersionMetadataReaderVersion = "2.1"

type DataSourceReaderVersionMetadata struct{…}

ReaderVersion DataSourceReaderVersionMetadataReaderVersionOptional

The version of the reader to use for this data source.

One of the following:

const DataSourceReaderVersionMetadataReaderVersion1_0 DataSourceReaderVersionMetadataReaderVersion = "1.0"

const DataSourceReaderVersionMetadataReaderVersion2_0 DataSourceReaderVersionMetadataReaderVersion = "2.0"

const DataSourceReaderVersionMetadataReaderVersion2_1 DataSourceReaderVersionMetadataReaderVersion = "2.1"