> ## 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/model-branches/merge-a-branch",
"feedback": "Description of the issue"
}
```
Only submit feedback when you have something specific and actionable to report.
# Merge a branch
> Merges a model branch into the shared model.
For PR-required and [git follower](/integrations/git/follower-mode) models, direct merges via API are rejected by default as they would bypass the intended git workflow. You can use the `force_override_git_settings` parameter to override this check when necessary, but git will not be synced to avoid force-pushing to `main`.
The `force_override_git_settings` parameter requires **Connection Admin** or **Organization Admin** permissions. Users with lesser permissions will receive a `403 Forbidden` error when attempting to use this parameter.
| Model Configuration | Default Behavior | With `force_override_git_settings: true` |
| ---------------------------- | ---------------------------- | ---------------------------------------- |
| No git | Merge succeeds, no git sync | N/A |
| Git enabled (no PR required) | Merge succeeds, syncs to git | N/A |
| Git + PR required | Rejected with 400 error | Merge succeeds, no git sync |
| Git + git follower | Rejected with 400 error | Merge succeeds, no git sync |
## OpenAPI
````yaml /api/openapi.yaml post /v1/models/{modelId}/branch/{branchName}/merge
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}/branch/{branchName}/merge:
post:
tags:
- Model branches
summary: Merge a branch
description: |
Merges a model branch into the shared model.
operationId: mergeBranch
parameters:
- name: modelId
in: path
required: true
schema:
type: string
format: uuid
description: The unique identifier of the model
example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
- name: branchName
in: path
required: true
schema:
type: string
description: The name of the branch to merge
example: feature/add-revenue-metrics
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
delete_branch:
type: boolean
default: false
description: Delete the branch after merging
publish_drafts:
type: boolean
default: true
description: When enabled, publish branch-attached drafts when merging
commit_message:
type: string
description: >-
Custom commit message for git sync. Defaults to `"branch
merged via API"`
example: Merged revenue metrics branch via CI/CD pipeline
force_override_git_settings:
type: boolean
default: false
description: >
**Requires Connection Admin or Organization Admin
permissions.** Users with lesser permissions will receive a
`403 Forbidden` error when attempting to use this parameter.
Allow merge for PR-required or git-follower models. When
enabled, the merge will succeed but git will not be synced
to avoid force-pushing to main.
example:
delete_branch: true
publish_drafts: true
commit_message: Merged revenue metrics branch via CI/CD pipeline
force_override_git_settings: false
responses:
'200':
description: Branch merged successfully
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: Whether the merge was successful
example: true
published_drafts_count:
type: integer
description: Number of drafts that were published during the merge
example: 2
failed_drafts_count:
type: integer
description: Number of drafts that failed to publish
example: 0
git_synced:
type: boolean
description: Whether the changes were synced to git
example: true
example:
success: true
published_drafts_count: 2
failed_drafts_count: 0
git_synced: true
'400':
description: Bad Request - Merge not allowed for this model configuration
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
prRequired:
summary: PR-required model without override
value:
error: >-
Cannot merge branch directly. This model requires pull
requests for changes. Use force_override_git_settings:
true to bypass.
gitFollower:
summary: Git-follower model without override
value:
error: >-
Cannot merge branch directly. This model follows git as
source of truth. Use force_override_git_settings: true to
bypass.
'403':
description: Forbidden - Insufficient permissions
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
insufficientPermissions:
summary: Modeler attempting to use force_override_git_settings
value:
error: >-
Insufficient permissions. The force_override_git_settings
flag requires Connection Admin or higher permissions.
'404':
$ref: '#/components/responses/NotFound'
'405':
description: Invalid HTTP method
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
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:
NotFound:
description: Not Found - Resource does not exist
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'
InternalServerError:
description: Internal Server Error
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`
````