> ## 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/documents/duplicate-published-document",
"feedback": "Description of the issue"
}
```
Only submit feedback when you have something specific and actionable to report.
# Duplicate published document
Only published documents can be duplicated. Attempting to duplicate a draft document will return a 404 error.
Duplicate a published document.
## OpenAPI
````yaml /api/openapi.yaml post /v1/documents/{documentId}/duplicate
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/documents/{documentId}/duplicate:
post:
tags:
- Documents
summary: Duplicate published document
operationId: duplicateDocument
parameters:
- name: documentId
in: path
required: true
schema:
type: string
description: Document identifier
- name: userId
in: query
schema:
type: string
description: >
**Requires an Organization API key**. Optional user ID that
attributes the action to the specified user.
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- name
properties:
name:
type: string
minLength: 1
maxLength: 255
description: The name for the duplicated document
folderPath:
oneOf:
- type: string
- type: 'null'
description: >-
Path to the destination folder. If not provided, the
document will be duplicated to the root.
scope:
type: string
enum:
- organization
- restricted
description: >
The visibility scope for the duplicated document.
If not provided, inherits from the destination folder or
defaults to `restricted`.
example:
name: My Dashboard Copy
folderPath: /reports/2024/q4
scope: organization
responses:
'201':
description: Document duplicated successfully
content:
application/json:
schema:
type: object
properties:
dashboardId:
type: string
description: >-
The dashboard ID, if the duplicated document has a
dashboard
identifier:
type: string
description: Unique identifier for the newly created document
name:
type: string
description: The name of the duplicated document
workbookId:
type: string
description: The workbook ID of the duplicated document
example:
dashboardId: abc123-dash-id
identifier: xyz789-new-identifier
name: My Dashboard Copy
workbookId: def456-workbook-id
'400':
description: |
Bad Request. Possible error messages:
- `name: Name cannot be empty`
- `name: Name must be 255 characters or less`
- `Scope "organization" and folder scope "restricted" do not match`
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Missing or invalid authentication
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: >
Insufficient permissions. Possible error messages:
- `User does not have access to create content on the specified
connection`
- `User-scoped API keys can only be used to act on behalf of the
authenticated user.`
- `Document duplication is disabled`. The document's duplication
permission is disabled.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: >
Not Found. Possible error messages:
- `Document with identifier "" not found`
- `Published document with id "" does not exist`. This
will surface when attempting to duplicate a draft.
- `Folder with path "" does not exist`
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'405':
$ref: '#/components/responses/MethodNotAllowed'
'429':
$ref: '#/components/responses/TooManyRequests'
security:
- bearerAuth: []
components:
schemas:
Error:
type: object
properties:
error:
type: string
description: HTTP response code for the error
example:
message:
type: string
description: Detailed error description
example:
responses:
MethodNotAllowed:
description: Method Not Allowed - Invalid HTTP method for this endpoint
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
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`
````