> ## 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. # Initiate download ## OpenAPI ````yaml /api/openapi.yaml post /v1/dashboards/{dashboardId}/download 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/dashboards/{dashboardId}/download: post: tags: - Dashboard downloads summary: Initiate download operationId: initiateDashboardDownload parameters: - name: dashboardId in: path required: true schema: type: string description: The dashboard identifier (ID or document UUID) - name: userId in: query required: false schema: type: string description: > The user ID to run the download as. Only valid when authenticating with an organization API key. Use the [List users](/api/users/list-users) or [List embed users](/api/users/list-embed-users) endpoints to retrieve user IDs. requestBody: required: true content: application/json: schema: type: object required: - format properties: format: type: string enum: - pdf - png - csv - xlsx - json description: > Output format: | Format | Full dashboard | Single tile | Notes | |--------|----------------|-------------|-------| | PDF | Yes | Yes | | | PNG | Yes | Yes | | | XLSX | Yes | Yes | | | CSV | Yes (as ZIP) | Yes | For full dashboards, delivery will be a zip file containing one CSV per tile | | JSON | No | Yes | Only single tile is supported. Requires `queryIdentifierMapKey` to be specified. | filename: type: string maxLength: 255 description: >- Custom filename for the downloaded file. Defaults to the dashboard name. queryIdentifierMapKey: type: string description: > Tile identifier to download a single tile instead of the full dashboard. Required for XLSX and JSON formats if `overrideRowLimit=true`. filterConfig: type: object description: Dashboard filter values to apply before rendering paperFormat: type: string enum: - fit_page - letter - legal - tabloid - a3 - a4 default: fit_page description: | **Applicable to PDF and PNG formats**. Page size. paperOrientation: type: string enum: - portrait - landscape description: | **Applicable to PDF and PNG formats**. Page orientation. hideTitle: type: boolean default: false description: > **Applicable to PDF and PNG formats**. If `true`, hide the dashboard title in the output. showFilters: type: boolean default: true description: > **Applicable to PDF and PNG formats**. If `true`, display applied filter values in the output. expandTablesToShowAllRows: type: boolean description: > **Applicable to PDF and PNG formats**. If `true`, expand table tiles to display all rows. singleColumnLayout: type: boolean description: > **Applicable to PDF and PNG formats**. If `true`, render tiles in a single column layout. enableFormatting: type: boolean default: false description: > **Applicable to CSV, XLSX, and JSON formats**. If `true`, preserve number and date formatting. hideHiddenFields: type: boolean default: false description: > **Applicable to CSV and XLSX formats**. If `true`, exclude hidden fields from the output. overrideRowLimit: type: boolean default: false description: > **Applicable to CSV, XLSX, and JSON formats**. Used with `maxRowLimit`. If `true`, remove the default row limit. If `true` for XLSX and JSON formats, a `queryIdentifierMapKey` is required. maxRowLimit: type: integer minimum: 1 maximum: 1000000 description: > **Applicable to CSV, XLSX, and JSON formats**. Maximum number of rows to export. Can be used with `overrideRowLimit` to export more rows than the default row limit. examples: fullDashboardPdf: summary: Download full dashboard as PDF value: format: pdf paperFormat: letter paperOrientation: landscape singleTileJson: summary: Download single tile as JSON value: format: json queryIdentifierMapKey: '1' csvWithOptions: summary: Download as CSV with formatting value: format: csv enableFormatting: true overrideRowLimit: true maxRowLimit: 50000 responses: '200': description: Download initiated successfully content: application/json: schema: type: object properties: job_id: type: string format: uuid description: >- The job ID to use for checking status and downloading the file message: type: string description: Success message example: job_id: 550e8400-e29b-41d4-a716-446655440000 message: Download initiated successfully '400': description: | Bad Request. Possible causes: - Missing required `format` field - Invalid format value - Invalid options for the specified format - Malformed JSON body - Invalid UUID format content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Insufficient permissions to download the specified dashboard content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Dashboard not found content: application/json: schema: $ref: '#/components/schemas/Error' '405': $ref: '#/components/responses/MethodNotAllowed' '409': description: A download is already in progress for the specified dashboard content: application/json: schema: type: object properties: detail: type: string description: Error message existing_job_id: type: string format: uuid description: The ID of the existing in-progress job status: type: string description: The status of the existing job example: detail: >- A download is already in progress for this dashboard. Please wait for it to complete or check its status. existing_job_id: 550e8400-e29b-41d4-a716-446655440000 status: EXECUTING '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` ````