Folders

Delete a folder

Delete a folder. By default, only empty folders can be deleted; pass ?recursive=true to delete a folder along with all of its subfolders and files. System folders cannot be deleted.

Org-scoped keys can delete non-access-controlled folders.

delete/folders/{id}

Request

Base URL
https://app.gc.ai/api/external/v1
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/gc-ai/apis/gc-ai-external-api/docs/folders/:id/delete.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring uuid required

The folder ID

Query parameters

recursive'true' | 'false'

When true, recursively delete subfolders and files. Defaults to false.

Example:true

Response

Folder deleted successfully

Changes

No recorded changes to this operation across all 1 revision of this API.