A valid request URL is required to generate request examples{
"success": true,
"data": {
"id": "kn_5a3d",
"agentId": "agt_4f9c2b7e10a24d51",
"organizationId": "org_2a1b9c",
"kind": "url",
"label": "Website FAQ",
"sourceUrl": "https://peakcomforthvac.com/faq",
"status": "indexed",
"refreshEnabled": true,
"refreshIntervalS": 604800,
"nextRefreshAt": "2026-07-17T12:00:00.000Z",
"createdAt": "2026-07-10T11:58:00.000Z",
"updatedAt": "2026-07-13T10:25:00.000Z"
}
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}Set a knowledge source's auto-refresh
Opts a website knowledge source into automatic re-crawl and re-index, or changes its cadence. Auto-refresh is opt-in and applies to URL sources only; the cadence has a 24-hour minimum (default weekly). Re-indexing happens only when the re-crawled content actually changed, so an unchanged site costs nothing beyond the crawl.
A valid request URL is required to generate request examples{
"success": true,
"data": {
"id": "kn_5a3d",
"agentId": "agt_4f9c2b7e10a24d51",
"organizationId": "org_2a1b9c",
"kind": "url",
"label": "Website FAQ",
"sourceUrl": "https://peakcomforthvac.com/faq",
"status": "indexed",
"refreshEnabled": true,
"refreshIntervalS": 604800,
"nextRefreshAt": "2026-07-17T12:00:00.000Z",
"createdAt": "2026-07-10T11:58:00.000Z",
"updatedAt": "2026-07-13T10:25:00.000Z"
}
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}Authorizations
Flowyte secret API key (Authorization: Bearer flowyte_sk_live_…). Scope-gated; is scoped to your organization — a key can never reach another tenant. The listed scopes in each operation's apiKey requirement are the scopes that key must hold. The tokenUrl is nominal: keys are minted in the dashboard.
- Token URL
- /api/v1/api-keys
Path Parameters
The agent this resource is scoped to (the UUID returned by createAgent / listAgents).
The knowledge source id (from listKnowledgeSources / createKnowledgeSource).