Knowledge Sources
Manage the training data for your AI agents.
GET
/api/agents/:id/sourcesJWTList Sources
List all knowledge sources for an agent.
Headers
| Header | Value |
|---|---|
| X-Workspace-ID | your-workspace-id |
URL Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | Required | Agent ID |
Response
json
{
"data": [
{
"id": "uuid",
"type": "file",
"name": "product-docs.pdf",
"status": "ready",
"chunks": 42,
"created_at": "2024-01-01T00:00:00Z"
}
]
}POST
/api/agents/:id/sources/urlJWTAdd URL Source
Scrape and index a web page. Requires owner or admin role.
Headers
| Header | Value |
|---|---|
| X-Workspace-ID | your-workspace-id |
URL Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | Required | Agent ID |
Request Body
| Name | Type | Required | Description |
|---|---|---|---|
| url | string | Required | URL to scrape |
Response
json
{
"data": {
"id": "uuid",
"type": "url",
"name": "https://example.com/faq",
"status": "processing"
},
"message": "URL source added successfully"
}POST
/api/agents/:id/sources/qaJWTAdd Q&A Pair
Add a question-answer pair. Requires owner or admin role.
Headers
| Header | Value |
|---|---|
| X-Workspace-ID | your-workspace-id |
URL Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | Required | Agent ID |
Request Body
| Name | Type | Required | Description |
|---|---|---|---|
| question | string | Required | Question text |
| answer | string | Required | Answer text |
Response
json
{
"data": {
"id": "uuid",
"type": "qa",
"status": "ready"
},
"message": "Q&A source added successfully"
}DELETE
/api/agents/:id/sources/:sidJWTDelete Source
Remove a knowledge source. Requires owner or admin role.
Headers
| Header | Value |
|---|---|
| X-Workspace-ID | your-workspace-id |
URL Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | Required | Agent ID |
| sid | string | Required | Source ID |
Response
json
{
"message": "Source deleted successfully"
}