Skip to main content
GET
/
agents
/
{agentId}
/
sources
/
summary
Get sources summary
curl --request GET \
  --url https://www.chatbase.co/api/v2/agents/{agentId}/sources/summary \
  --header 'Authorization: Bearer <token>'
{
  "links": {
    "count": 123,
    "size": 123
  },
  "files": {
    "count": 123,
    "size": 123
  },
  "qnas": {
    "count": 123,
    "size": 123
  },
  "notionPages": {
    "count": 123,
    "size": 123
  },
  "texts": {
    "count": 123,
    "size": 123
  },
  "zendeskTickets": {
    "count": 123,
    "size": 123
  },
  "salesforceCases": {
    "count": 123,
    "size": 123
  },
  "shouldRetrain": true
}

Authorizations

Authorization
string
header
required

API key from your account settings

Path Parameters

agentId
string
required

The agent ID

Minimum string length: 1
Example:

"5QHA6VB-DIAbBhxwqxfdi"

Response

Sources summary by type

Aggregated stats for link sources

files
object
required

Aggregated stats for file sources

qnas
object
required

Aggregated stats for Q&A sources

notionPages
object
required

Aggregated stats for Notion sources

texts
object
required

Aggregated stats for text sources

zendeskTickets
object
required

Aggregated stats for Zendesk ticket sources. count = total number of ticket IDs tracked

salesforceCases
object
required

Aggregated stats for Salesforce case sources. count = total number of case IDs tracked

shouldRetrain
boolean
required

True when the agent knowledge base requires a retrain to reflect any changes