> ## 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.
# Create or update a pull request for a model branch
>
This endpoint requires **Modeler** or **Connection Admin** permisisons.
Pushes a branch's model contents to git and creates or updates a pull request. This mirrors the **Create Pull Request** / **Update Pull Request** buttons in Omni allowing API consumers and AI agents to drive the pull request workflow programmatically.
By default, the endpoint automatically detects whether the git branch exists. If a branch doesn't exist, a successful request will create a new git branch and open a pull request. If a branch does exist, a commit will be added to the branch.
The `allow_branch_exists` and `require_branch_exists` parameters constrain this behavior:
- **Create or update mode** (default) - Auto-detects and handles both scenarios
- **Create-only mode** (`allow_branch_exists: false`) - Fails if the git branch already exists
- **Update-only mode** (`require_branch_exists: true`) - Fails if the git branch doesn't exist
## OpenAPI
````yaml /api/openapi.yaml post /v1/models/{modelId}/git/commit
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}/git/commit:
post:
tags:
- Model git configuration
summary: Create or update a pull request for a model branch
description: >
This endpoint requires **Modeler** or **Connection Admin** permisisons.
Pushes a branch's model contents to git and creates or updates a pull
request. This mirrors the **Create Pull Request** / **Update Pull
Request** buttons in Omni allowing API consumers and AI agents to drive
the pull request workflow programmatically.
By default, the endpoint automatically detects whether the git branch
exists. If a branch doesn't exist, a successful request will create a
new git branch and open a pull request. If a branch does exist, a commit
will be added to the branch.
The `allow_branch_exists` and `require_branch_exists` parameters
constrain this behavior:
- **Create or update mode** (default) - Auto-detects and handles both
scenarios
- **Create-only mode** (`allow_branch_exists: false`) - Fails if the git
branch already exists
- **Update-only mode** (`require_branch_exists: true`) - Fails if the
git branch doesn't exist
operationId: commitModelBranch
parameters:
- name: modelId
in: path
required: true
schema:
type: string
format: uuid
description: The unique identifier of the shared model.
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- branch_id
- commit_message
properties:
branch_id:
type: string
format: uuid
description: UUID of the Omni branch to commit.
example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
commit_message:
type: string
description: Commit message for the git commit.
example: Add new customer dimension
allow_branch_exists:
type: boolean
default: true
description: >
Set `false` to fail if git branch already exists
(**Create-only mode**).
example: true
require_branch_exists:
type: boolean
default: false
description: >
Set `true` to fail if git branch doesn't exist
(**Update-only mode**).
example: false
example:
branch_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
commit_message: Add new customer dimension
allow_branch_exists: true
require_branch_exists: false
responses:
'200':
description: Commit operation completed successfully
content:
application/json:
schema:
type: object
properties:
pr_url:
type: string
description: URL of the created or updated pull request.
example: >-
https://github.com/myorg/repo/compare/main...feature?expand=1
git_sha:
type: string
description: The git SHA of the commit.
example: abc123def456
in_sync:
type: boolean
description: >-
Whether the shared model is currently in sync with its
configured default git branch.
example: true
did_sync:
type: boolean
description: >-
Whether a sync operation was performed between the shared
model and its configured default git branch.
example: true
example:
pr_url: https://github.com/myorg/repo/compare/main...feature?expand=1
git_sha: abc123def456
in_sync: true
did_sync: true
'400':
description: >
Bad Request
Possible error messages:
- `Bad Request: modelId: Invalid uuid`
- `Bad Request: branch_id: Invalid uuid`
- `Bad Request: commit_message is required`
- `Bad Request: Cannot set both allow_branch_exists=false and
require_branch_exists=true`
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Missing or invalid authentication
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: >
Forbidden
Possible error messages:
- `Forbidden: Requires MANAGE_MODEL permission` - This endpoint
requires **Modeler** or **Connection Admin** permisisons.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: |
Not Found
Possible error messages:
- `Not Found: Model does not exist`
- `Not Found: Branch does not exist`
- `Not Found: Git configuration not found for this model`
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'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:
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`
````