Skip to content

List sources for knowledge base

GET
/knowledge-bases/{knowledgeBaseId}/sources
knowledgeBaseId
required

Unique identifier for the knowledge base to retrieve

string

Unique identifier for the knowledge base to retrieve

status

Filter sources by processing status

string
nullable

Filter sources by processing status

page

Page number for pagination (1-indexed)

number
>= 1

Page number for pagination (1-indexed)

pageSize

Number of results per page (1-100, default: 20)

number
>= 1 <= 100

Number of results per page (1-100, default: 20)

orderBy

Field to sort results by

string
Allowed values: addedAt processedAt status

Field to sort results by

orderDirection

Sort direction: ascending or descending

string
Allowed values: asc desc

Sort direction: ascending or descending

Sources retrieved successfully

object
sources
required

Array of sources

Array<object>
object
knowledgeBaseSourceId
required

Unique identifier for the source (nanoid format)

string
knowledgeBaseId
required

ID of the parent knowledge base

string
fileId
required

ID of the file source (mutually exclusive with tableId)

string
nullable
datasetTableId
required

ID of the dataset table source (mutually exclusive with fileId)

string
nullable
columnSpec
required

For table sources: specifies which columns to process

object
columns
required

Column names to extract content from

Array<string>
status
required

Processing status of the source

string
Allowed values: pending processing processed failed stale
processedExtractionId
required

ID of the extraction used when this source was processed

string
nullable
processedDatasetVersion
required

Version of dataset when last processed

number
nullable
addedAt
required

ISO 8601 timestamp when the source was added

string format: date-time
processedAt
required

ISO 8601 timestamp when the source was last processed

string format: date-time
nullable
syncErrorMessage
required

Error message from the most recent failed sync attempt

string
nullable
metadata
required

User-defined metadata for filtering retrieval

object
key
additional properties
Any of:
string
metadataStale
required

True if metadata has changed and chunks need re-indexing

boolean
total
required

Total number of sources (before pagination)

number
page
required

Current page number

number
pageSize
required

Number of results per page

number

Bad Request - Validation error or invalid input

object
error
required
string
code
string
details
nullable
retryable
boolean

Unauthorized - Authentication required or invalid token

object
error
required
string
code
string
details
nullable
retryable
boolean

Forbidden - Insufficient permissions

object
error
required
string
code
string
details
nullable
retryable
boolean

Not Found - Resource does not exist

object
error
required
string
code
string
details
nullable
retryable
boolean