Get Refresh Config | Speechify API

Read the per-document auto-refresh state.

Authentication

AuthorizationBearer

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

Path parameters

kb_idstringRequired

document_idstringRequired

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 document's refresh config.

enabledboolean

interval_daysinteger

auto_remove_enabledboolean

last_refreshed_atdatetime or null

consecutive_fetch_failuresinteger

Errors

401

Unauthorized Error

404

Not Found Error

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