Update Folder | Speechify API

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

AuthorizationBearer

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

idstringRequired

folderIdstringRequired

This endpoint expects an object.

namestringOptional

parent_folder_idstringOptional

Folder to reparent under. Prefixed wire identifier (kfolder_<26 char Crockford base32>).

clear_parent_folder_idbooleanOptional

When true, moves the folder to root (clears parent_folder_id). Wins over parent_folder_id when both are sent.

The updated folder.

idstring

kb_idstring

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

parent_folder_idstring or null

namestring

document_countinteger

created_atdatetime

updated_atdatetime

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

$	curl -X PATCH https://api.speechify.ai/v1/agents/knowledge-bases/id/folders/folderId \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"id": "kfolder_01krdk9hzct70r12s7z5a4xtsh",
3	"kb_id": "string",
4	"parent_folder_id": "string",
5	"name": "string",
6	"document_count": 1,
7	"created_at": "2024-01-15T09:30:00Z",
8	"updated_at": "2024-01-15T09:30:00Z"
9	}