> ## 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.
# Read app content on a draft
>
This API is currently in development and may change.
Read the app content on a specified draft.
## OpenAPI
````yaml /api/openapi.yaml get /v2/documents/{documentId}/draft/{draftId}/app
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: Who Am I
description: Inspect your own user permissions
- name: AI
description: AI-powered query generation
- name: AI Credit Controls
description: Manage organization-level AI credit usage
- name: AI Credit Usage
description: Monitor AI credit usage
- name: AI Evals
description: >-
Manage prompt sets and runs used to score AI quality against curated
prompt suites.
- name: AI Model Suggestions
description: Manage AI-generated suggestions for shared models
- name: AI Routines
description: >-
Manage Routines, which are scheduled, recurring AI-powered tasks that run
automatically on your data
- name: Apps
description: Draft and publish app documents.
- name: Documents v2
description: >
A draft-based workflow for creating and editing documents: create a
document, patch a draft, then publish.
- name: Documents
description: Create, retrieve, and manage documents
- 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: 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 the organization
- name: Folders
description: Create and organize content folders
- name: Folder labels
description: Apply and manage labels on 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:
/v2/documents/{documentId}/draft/{draftId}/app:
get:
tags:
- Apps
summary: Read app content on a draft
description: |-
This API is currently in development and may change.
Read the app content on a specified draft.
operationId: getDraftApp
parameters:
- name: draftIdentifier
schema:
type: string
example: def456
required: true
description: >-
Draft identifier. Use [List document
drafts](/api/documents/list-document-drafts) to retrieve draft IDs.
in: path
- name: documentId
schema:
type: string
example: abc123
required: true
description: Published document identifier.
in: path
- name: pretty
schema:
type: string
enum:
- '0'
- '1'
- 'true'
- 'false'
required: false
description: >-
Set `true` or `1` to pretty-print (2-space indent) the response;
`false` / `0` (the default) is compact. Key ordering is
deterministic regardless.
in: query
responses:
'200':
description: The draft's app content.
content:
application/json:
schema:
$ref: '#/components/schemas/AppHTMLSettings'
'401':
description: Authentication required.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError401'
'403':
description: Insufficient permissions to read the document.\
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError403'
'404':
description: >-
Document or draft not found, the draft has no app, or the
organization has apps disabled.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError404'
'405':
description: Method not allowed.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
schemas:
AppHTMLSettings:
type: object
required:
- html
- settings
description: |
The published app's HTML and sandbox settings.
properties:
html:
type: string
description: The complete app HTML document.
settings:
$ref: '#/components/schemas/AppSettings'
ApiError401:
type: object
properties:
detail:
type: string
description: Human-readable error message describing what went wrong.
example: 'Unauthorized: Missing or invalid API key'
status:
type: integer
description: HTTP status code of the error.
example: 401
required:
- detail
- status
ApiError403:
type: object
properties:
detail:
type: string
description: Human-readable error message describing what went wrong.
status:
type: integer
description: HTTP status code of the error.
example: 403
required:
- detail
- status
ApiError404:
type: object
properties:
detail:
type: string
description: Human-readable error message describing what went wrong.
status:
type: integer
description: HTTP status code of the error.
example: 404
required:
- detail
- status
Error:
type: object
properties:
error:
type: string
description: HTTP response code for the error
example:
message:
type: string
description: Detailed error description
example:
AppSettings:
type: object
additionalProperties: false
description: >
The app's sandbox settings. A write replaces the whole object; omitted
fields use their locked-down defaults. Host lists are normalized
(deduped, invalid or Omni-owned hosts dropped) before they are stored.
properties:
allowClipboard:
type: boolean
default: false
description: Allow the app to read from and write to the user's clipboard.
allowDefaultMapProviders:
type: boolean
default: false
description: Allow the app to load Omni's default map tile providers.
allowDownloads:
type: boolean
default: false
description: Allow the app to trigger file downloads.
allowExternalNavigation:
type: boolean
default: false
description: >-
Allow the app to navigate to domains outside the `navAllowedDomains`
/ `safeDomains` allowlists.
allowInternalNavigation:
type: boolean
default: false
description: Allow the app to navigate within the Omni instance.
externalNavOpensInNewTab:
type: boolean
default: true
description: >-
When true, external navigation opens in a new tab instead of the
current one.
navAllowedDomains:
type: array
items:
type: string
default: []
description: >-
Domains the app is allowed to navigate to when
`navAllowedDomainsEnabled` is true.
navAllowedDomainsEnabled:
type: boolean
default: false
description: >-
When true, restrict navigation to the domains listed in
`navAllowedDomains`.
safeDomains:
type: array
items:
type: string
default: []
description: >-
Domains treated as safe for embedded content when
`safeDomainsEnabled` is true.
safeDomainsEnabled:
type: boolean
default: false
description: >-
When true, restrict embedded content to the domains listed in
`safeDomains`.
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#token-types).
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`
````