> ## Documentation Index
> Fetch the complete documentation index at: https://docs.omni.co/llms.txt
> Use this file to discover all available pages before exploring further.
## Submitting Feedback
If you encounter incorrect, outdated, or confusing documentation on this page, submit feedback:
POST https://docs.omni.co/feedback
```json
{
"path": "/api/folders/delete-folder",
"feedback": "Description of the issue"
}
```
Only submit feedback when you have something specific and actionable to report.
# Delete folder
> Delete a folder. By default, only empty folders can be deleted. Use the `force` parameter to recursively delete folders containing documents and sub-folders.
When `force` is enabled:
- All documents are archived (soft-delete to trash) across the folder tree
- Subfolders are deleted recursively, starting with the most deeply-nested subfolder and walking up the folder tree
- Up to 100 items (documents and subfolders) can be deleted. If a folder contains more than 100 items, the item will return a `400`. No items will be deleted.
- All operations occur in a single transaction - partial failures roll back completely
- SSO embed users cannot force-delete entity folders
## OpenAPI
````yaml /api/openapi.yaml delete /v1/folders/{folderId}
openapi: 3.1.0
info:
title: Omni API
description: >
The Omni REST API provides programmatic access to your Omni instance for
managing users, documents, queries, schedules, and more.
version: 1.0.0
contact:
name: Omni Support
url: https://docs.omni.co
servers:
- url: https://{instance}.omniapp.co/api
description: Production
variables:
instance:
default: blobsrus
description: Your production Omni instance subdomain
- url: https://{instance}.playground.exploreomni.dev/api
description: Playground
variables:
instance:
default: blobsrus
description: Your playground Omni instance subdomain
security:
- bearerAuth: []
- orgApiKey: []
tags:
- name: AI
description: AI-powered query generation
- name: API Tokens
description: >-
Manage API tokens (Organization keys, Personal Access Tokens, MCP OAuth
grants)
- name: Connections
description: Manage database connections
- name: Connection environments
description: Manage connection environments database connections
- name: Content
description: Unified content retrieval (documents and folders)
- name: Content migration
description: Export and import dashboards
- name: Content validator
description: Validate content against models and perform find/replace operations
- name: Dashboard downloads
description: Download dashboards and tiles as PDF, PNG, XLSX, CSV, or JSON files
- name: Dashboard filters and controls
description: Read and update dashboard filter and control default values
- name: dbt
description: Manage dbt configuration for connections
- name: Documents
description: Create, retrieve, and manage documents
- name: Document favorites
description: Favorite and unfavorite documents
- name: Document labels
description: Apply and manage labels on documents
- name: Document permissions
description: Manage document-level access
- name: Labels
description: >
Manage labels in an organization. Labels can be applied to documents and
folders to help organize and categorize content.
**Label types:**
- **Basic labels**: Can be created and managed by any user
- **Verified labels**: Indicate curated or officially sanctioned content.
Admin-only.
- **Homepage labels**: Appear on the organization homepage. Admin-only.
- name: Folders
description: Create and organize content folders
- name: Folder permissions
description: Manage folder-level access
- name: Jobs
description: Check status of asynchronous jobs
- name: Models
description: Create and manage data models
- name: Model branches
description: Manage model branches and merge changes
- name: Model git configuration
description: Manage git configuration for shared models
- name: Queries
description: Execute workbook queries
- name: Schedules
description: Create and manage scheduled tasks
- name: Schedule recipients
description: Manage schedule recipients
- name: Schema refresh schedules
description: Manage automated schema refresh schedules for connections
- name: Topics
description: Retrieve topic information from models
- name: Uploads
description: Manage file uploads
- name: Users
description: Manage users
- name: User attributes
description: Manage user attribute definitions
- name: User groups
description: Manage user groups
- name: User model roles
description: Manage model and connection role assignments for users
- name: User group model roles
description: Manage model and connection role assignments for user groups
- name: Uploads
description: Manage CSV and spreadsheet uploads
paths:
/v1/folders/{folderId}:
delete:
tags:
- Folders
summary: Delete folder
description: >
Delete a folder. By default, only empty folders can be deleted. Use the
`force` parameter to recursively delete folders containing documents and
sub-folders.
When `force` is enabled:
- All documents are archived (soft-delete to trash) across the folder
tree
- Subfolders are deleted recursively, starting with the most
deeply-nested subfolder and walking up the folder tree
- Up to 100 items (documents and subfolders) can be deleted. If a folder
contains more than 100 items, the item will return a `400`. No items
will be deleted.
- All operations occur in a single transaction - partial failures roll
back completely
- SSO embed users cannot force-delete entity folders
operationId: deleteFolder
parameters:
- name: folderId
in: path
required: true
schema:
type: string
format: uuid
description: >-
The UUID of the folder to delete. Use the [List
folders](/api/folders/list-folders) endpoint to retrieve folder IDs.
- name: force
in: query
required: false
schema:
type: boolean
default: false
description: >-
When `true`, recursively archives documents (to trash) and deletes
sub-folders. Limited to 100 total items.
responses:
'200':
description: Folder deleted successfully
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessResponse'
'400':
description: >
Bad Request
Possible error messages:
- `Folders with documents cannot be deleted` (when `force=false` and
folder is not empty)
- `Only empty folders can be deleted` (when `force=false` and folder
is not empty)
- `Folder contains too many items to force delete. Found
items (limit: 100)` (when `force=true` and folder tree exceeds 100
items)
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: >
Forbidden
Possible error messages:
- Permission denied (when user lacks delete permission)
- SSO embed users cannot force-delete entity folders (when SSO embed
user attempts to force-delete entity folder)
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: |
Not Found
Possible error messages:
- `Folder with id does not exist`
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'429':
$ref: '#/components/responses/TooManyRequests'
security:
- bearerAuth: []
components:
schemas:
SuccessResponse:
type: object
properties:
success:
type: boolean
example: true
Error:
type: object
properties:
error:
type: string
description: HTTP response code for the error
example:
message:
type: string
description: Detailed error description
example:
responses:
TooManyRequests:
description: Too Many Requests - Rate limit exceeded (60 requests/minute)
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: >
Can be either an [Organization API
Key](/api/authentication#organization-api-keys) or [Personal Access
Token (PAT)](/api/authentication#personal-access-tokens-pat).
Include in the `Authorization` header as: `Bearer YOUR_TOKEN`
orgApiKey:
type: http
scheme: bearer
bearerFormat: JWT
description: >
Requires an [Organization API
Key](/api/authentication#organization-api-keys). Personal Access Tokens
(PATs) are not supported for this endpoint.
Include in the `Authorization` header as: `Bearer ORGANIZATION_API_KEY`
````