Skip to main content
PUT
Set a source's refresh schedule

Authorizations

Authorization
string
header
required

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

Kallabot-Version
enum<string>

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.

Available options:
2026-11-07
Example:

"2026-11-07"

Path Parameters

source_id
string
required

Body

application/json
interval_hours
integer | null

Read the source again this often; null stops.

Required range: 1 <= x <= 720
crawl
CrawlSettings · object | null

Response

Successful Response

id
string
required

The source id.

kind
string
required

url, file, text, sheet or catalog.

status
string
required

Where indexing stands, e.g. queued, indexing, ready, failed.

warnings
any[]
required

Things worth knowing that didn't stop it.

crawl
Crawl · object
required

Website crawl settings: include, exclude, max_pages.

updated_at
string
required

ISO 8601.

name
string | null

Its name.

progress
integer | null

Indexing progress, 0 to 100.

error
string | null

Why it failed.

chunks
integer | null

Passages indexed.

tokens
integer | null

Its size in tokens.

language
string | null

The language detected.

description
string | null

What it covers, for the agent.

indexed_at
string | null

When it was last indexed.

refresh_interval_hours
integer | null

Read again this often; null is never.

next_refresh_at
string | null

The next scheduled read.

last_refreshed_at
string | null

The last scheduled read.

price_as_of
string | null

A catalog's prices are as of this time.