> ## 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/models/create-or-update-yaml-files",
"feedback": "Description of the issue"
}
```
Only submit feedback when you have something specific and actionable to report.
# Create or update YAML files
> Creates or overwrites a YAML file for a model. The file can be a special file (`model` or `relationships`) or a YAML file ending in `.topic` or `.view`.
The following models cannot be edited using this endpoint:
- Schema models
- Models using git follower mode
## OpenAPI
````yaml /api/openapi.yaml post /v1/models/{modelId}/yaml
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/models/{modelId}/yaml:
post:
tags:
- Models
summary: Create or update YAML files
description: >
Creates or overwrites a YAML file for a model. The file can be a special
file (`model` or `relationships`) or a YAML file ending in `.topic` or
`.view`.
The following models cannot be edited using this endpoint:
- Schema models
- Models using git follower mode
operationId: updateModelYaml
parameters:
- name: modelId
in: path
required: true
schema:
type: string
format: uuid
description: The ID of the model.
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- fileName
- yaml
- mode
properties:
branchId:
type: string
format: uuid
description: >
**Required if git pull requests are required for the
model.** The ID of the branch to create or update. To
retrieve branch IDs, use the [List
models](/api/models/list-models) endpoint with
`modelKind=BRANCH`.
fileName:
type: string
description: >
The name of the YAML file. Valid values are:
- `model` - [Model file](/modeling/models)
- `relationships` - [Relationships
file](/modeling/relationships)
- `.topic` - [Topic
file](/modeling/topics/parameters)
- `.view` - [View file](/modeling/views)
yaml:
type: string
description: >
The YAML contents of the file. This can be empty, in which
case:
- If empty and used with `mode: extension` the file will be
removed from the model
- If empty and used with `mode: combined`, the file will be
ignored in the model
mode:
type: string
default: combined
enum:
- combined
- extension
- staged
- merged
- history
description: >
The mode to use when creating or overwriting the YAML file.
**Note**: Workbook models must use `combined` mode if there
is a `branchId`.
commitMessage:
type: string
description: >
**Required for [git-enabled models](/integrations/git).**
Commit message describing the change.
previousChecksum:
type: string
description: >
Checksum of the file when fetched, for conflict detection.
Obtain this value from the [Get model YAML
endpoint](/api/models/get-model-yaml) by including the
`includeChecksums` parameter.
If the file has been modified since you fetched it, the
request will fail with a `File has been modified since it
was fetched` error.
fullyResolved:
type: boolean
default: false
description: >
If `true`, accepts fully-resolved YAML. This means that Omni
will resolve any extension (`extends`) usage and place the
changes into the appropriate model files.
When `false` (default), the YAML is saved as-is to the
specified file. This means that even if extensions are used,
they will not be included in the changes.
responses:
'200':
description: YAML file updated successfully
content:
application/json:
schema:
type: object
properties:
fileName:
type: string
description: The name of the file that was created or updated.
success:
type: boolean
description: Indicates the request was successful.
'400':
description: |
Bad Request
Possible error messages:
- `: is required`
- `modelId: Invalid uuid`
- `branchId: Invalid uuid`
- `: Invalid value `
- `File has been modified since it was fetched`
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: |
Forbidden
Possible error messages:
- `Permission denied`
- `Feature not enabled`
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: |
Not Found
Possible error messages:
- `Model with id does not exist`
- `Branch 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`
````