Update Refresh Config | SpeechifyAI API

Update the per-document auto-refresh state. Only meaningful for url-sourced documents; file and text rows reject the request.

Authentication

AuthorizationBearer

Enter your API key with the Bearer prefix, e.g. ‘Bearer sk_…’.

Path parameters

kb_idstringRequired

Knowledge base id (prefixed external id, kb_...).

document_idstringRequired

Knowledge-base document id (prefixed external id, doc_...).

Request

This endpoint expects an object.

enabledbooleanOptional

interval_daysintegerOptional

auto_remove_enabledbooleanOptional

Response headers

X-Request-IDstring

Unique identifier for this request, present on every response (2xx and non-2xx alike). If the caller sends an X-Request-ID request header the server echoes it back (sanitized and length-capped) so one logical request can be traced end-to-end; otherwise the server generates a fresh value. Log it on every response and quote it in support requests - it is the stable handle that ties your observation to Speechify’s server-side logs, and it matches the request_id field in the error envelope.

Unique identifier for this request, present on every response (2xx and non-2xx alike). If the caller sends an `X-Request-ID` request header the server echoes it back (sanitized and length-capped) so one logical request can be traced end-to-end; otherwise the server generates a fresh value. Log it on every response and quote it in support requests - it is the stable handle that ties your observation to Speechify's server-side logs, and it matches the `request_id` field in the error envelope.

Response

The updated refresh config.

enabledboolean

interval_daysinteger

auto_remove_enabledboolean

last_refreshed_atdatetime or null

consecutive_fetch_failuresinteger

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

$	curl -X PATCH https://api.speechify.ai/v1/agents/knowledge-bases/kb_01jqr8x9zg5k2m3n4p5q6r7s8t/documents/doc_01jqr8x9zg5k2m3n4p5q6r7s8t/refresh-config \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"enabled": true,
>	"interval_days": 1,
>	"auto_remove_enabled": true
>	}'

1	{
2	"enabled": true,
3	"interval_days": 1,
4	"auto_remove_enabled": true,
5	"last_refreshed_at": "2026-06-24T18:03:11Z",
6	"consecutive_fetch_failures": 1
7	}