Get source details

GET

/api/sources/{sourceId}

const url = 'https://firma.company-gpt.com/companygpt/rag/api/api/sources/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://firma.company-gpt.com/companygpt/rag/api/api/sources/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Authorizations

BearerAuth

Parameters

Path Parameters

sourceId

required

string format: uuid

Responses

200

Source details

application/json

Data source configuration (database.SourceConfig)

object

required

string format: uuid

name

required

string

sourceType

required

string

Allowed values: webcrawl sharepoint nextcloud git

config

required

Source-specific configuration

object

key

additional properties

any

enabled

required

boolean

syncSchedule

string

nullable

Allowed values: hourly daily weekly

collectionId

string format: uuid

nullable

createdBy

string format: uuid

nullable

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

lastSyncAt

string format: date-time

nullable

Example

{
  "sourceType": "webcrawl",
  "syncSchedule": "hourly"
}

400

Invalid source ID

401

Unauthorized

404

Source not found