folders

Modify Folder

Update the name or documentation of an existing data folder.

Path parameters

folder_idstringRequired

Headers

AuthorizationstringRequired

Header authentication of the form Bearer <token>

Request

This endpoint expects an object.
namestring or nullOptional
The name of the source.
descriptionstring or nullOptional
The description of the source.
instructionsstring or nullOptional
Instructions for how to use the source.
metadatamap from strings to any or nullOptional
Metadata associated with the source.
embedding_configobject or nullOptional
The embedding configuration used by the source.

Response

Successful Response
namestring
The name of the folder.
embedding_configobject
The embedding configuration used by the folder.
descriptionstring or null
The description of the folder.
instructionsstring or null
Instructions for how to use the folder.
metadatamap from strings to any or null
Metadata associated with the folder.
idstring or nullformat: "^source-[a-fA-F0-9]{8}"

The human-friendly ID of the Source

created_by_idstring or null
The id of the user that made this Tool.
last_updated_by_idstring or null
The id of the user that made this Tool.
created_atstring or nullformat: "date-time"
The timestamp when the folder was created.
updated_atstring or nullformat: "date-time"
The timestamp when the folder was last updated.

Errors