Folders

Folders hold the different types of documents and templates.

Create folder

POSThttps://api.openai.com/v1/create_folder

Creates a folder

Request body

Name String Required The name of the folder to create

Desc String A detailed description of the folder's purpose or content

Returns

The created folder object

Fetching folder

GEThttps://api.openai.com/v1/fetch_folder/{folder_id}

Fetches all information about a folder, using the folder_id

Path parameters

Folder_id Integer Required The id of the folder to fetch

Returns

The folder object

Update folder

PUThttps://api.openai.com/v1/update_folder/{folder_id}

Updates a folder, using the folder_id

Path parameters

Folder_id Integer Required The id of the folder to update

Request body

Name String The name of the folder to update

Desc String A detailed description of the folder's purpose or content to update

Returns

The folder object

Delete folder

DELETEhttps://api.openai.com/v1/delete_folder/{folder_id}

Deletes a folder, using the folder_id

Path parameters

Folder_id Integer Required The id of the folder to delete

Override Boolean If True forces deletion. Default False

Folder Object

id Integer

name String The name of the folder

desc String A detailed description of the folder's purpose or content

Last updated

Was this helpful?