folders

List Folders

List all data folders created by a user.

Headers

AuthorizationstringRequired

Header authentication of the form Bearer <token>

Query parameters

beforestring or nullOptional
Folder ID cursor for pagination. Returns folders that come before this folder ID in the specified sort order
afterstring or nullOptional
Folder ID cursor for pagination. Returns folders that come after this folder ID in the specified sort order
limitinteger or nullOptionalDefaults to 50
Maximum number of folders to return
orderenumOptionalDefaults to asc
Sort order for folders by creation time. 'asc' for oldest first, 'desc' for newest first
Allowed values:
order_by"created_at"OptionalDefaults to created_at
Field to sort by
namestring or nullOptional
Folder name to filter by

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