Set a source's refresh schedule
Re-reads a website or Google Sheet every interval_hours (1 to 720); null stops it. For websites, crawl also sets which paths to include or exclude and how many pages to read.
Scopes: knowledge:write
Authorizations
An API key from Settings → API keys, sent as Authorization: Bearer kb_live_…. A workspace key starts kb_; a personal key starts kbp_ and acts as its owner.
Headers
The API version to answer as, a date (YYYY-MM-DD). Leave it out for the current version (2026-11-07). An unknown version is refused with 400 unsupported_api_version.
2026-11-07 "2026-11-07"
Path Parameters
Body
Response
Successful Response
The source id.
url, file, text, sheet or catalog.
Where indexing stands, e.g. queued, indexing, ready, failed.
Things worth knowing that didn't stop it.
Website crawl settings: include, exclude, max_pages.
ISO 8601.
Its name.
Indexing progress, 0 to 100.
Why it failed.
Passages indexed.
Its size in tokens.
The language detected.
What it covers, for the agent.
When it was last indexed.
Read again this often; null is never.
The next scheduled read.
The last scheduled read.
A catalog's prices are as of this time.