Update Folder

Beta

Update a folder. Pass parent_folder_id: null to move to root; omit the field to leave it unchanged.

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_...).

folder_idstringRequired

Knowledge-base folder id (prefixed external id, kfolder_...).

Headers

Speechify-VersionstringOptional

Request

This endpoint expects an object.
namestringOptional
parent_folder_idstring or nullOptional

Folder to reparent under (prefixed wire identifier kfolder_<26 char Crockford base32>), or null to move the folder to the knowledge base root. Omit to leave unchanged.

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.

Response

The updated folder.
idstringformat: "^kfolder_[0-9a-hjkmnp-tv-z]{26}$"
kb_idstringformat: "^kb_[0-9a-hjkmnp-tv-z]{26}$"

Prefixed wire identifier (kb_<26 char Crockford base32>) of the owning knowledge base.

parent_folder_idstring or nullformat: "^kfolder_[0-9a-hjkmnp-tv-z]{26}$"
namestring
document_countinteger
created_atdatetime
updated_atdatetime

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error