Skip to main content
GET
Get a Knowledge Source
The response covers its content or source location, whether it is active, and its indexStatus, lastIndexedUtc, and indexError.

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Path Parameters

id
integer<int64>
required

The ID of the knowledge source.

Response

OK

Response model for a knowledge source.

id
integer<int64>

The unique identifier of the knowledge source.

title
string | null

The title of the knowledge source.

description
string | null

The description of what the knowledge source covers.

sourceType
enum<integer>

Where the content comes from: text you send, an uploaded file, or a URL.

Available options:
0,
1,
2,
3,
4,
5
content
string | null

The text of the knowledge source, when the content is sent inline.

blobPath
string | null

The path returned by Upload a Knowledge Source File, when the content comes from a file.

sourceUrl
string | null

The URL to index, when the content comes from a website.

indexStatus
enum<integer>

How far along indexing the source is, such as Pending, Indexed, or Failed.

Available options:
0,
1,
2
lastIndexedUtc
string<date-time> | null

The UTC date and time the source was last indexed.

indexError
string | null

The reason indexing failed, when indexStatus is a failure.

isActive
boolean

Whether the knowledge source is active and used for generation.

createdDateTimeUtc
string<date-time>

The UTC date and time the knowledge source was created.

modifiedDateTimeUtc
string<date-time>

The UTC date and time the knowledge source was last modified.

Last modified on July 28, 2026