> ## 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-git-configuration/get-git-configuration",
"feedback": "Description of the issue"
}
```
Only submit feedback when you have something specific and actionable to report.
# Get git configuration
> Retrieves the git configuration for a shared model.
## OpenAPI
````yaml /api/openapi.yaml get /v1/models/{modelId}/git
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:
get:
tags:
- Model git configuration
summary: Get git configuration
description: |
Retrieves the git configuration for a shared model.
operationId: getModelGitConfig
parameters:
- name: modelId
in: path
required: true
schema:
type: string
format: uuid
description: The unique identifier of the shared model.
- name: include
in: query
required: false
schema:
type: string
enum:
- webhookSecret
description: >
Comma-separated list of additional fields to include in the
response.
- `webhookSecret` - Include the webhook secret in the response
responses:
'200':
description: Git configuration retrieved successfully
content:
application/json:
schema:
$ref: '#/components/schemas/ModelGitConfig'
example:
authMethod: ssh
baseBranch: main
branchPerPullRequest: false
gitFollower: false
gitServiceProvider: github
modelPath: omni/blobs_r_us
publicKey: ssh-ed25519 AAAA...
requirePullRequest: users-only
cloneUrl: git@github.com:org/repo.git
webUrl: https://github.com/org/repo
webhookUrl: https://app.omni.co/api/webhooks/model/...
'400':
description: |
Bad Request
Possible error messages:
- `Bad Request: modelId: Invalid uuid`
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`
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: |
Not Found
Possible error messages:
- `Not Found: Model 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:
ModelGitConfig:
type: object
properties:
authMethod:
type: string
enum:
- ssh
- https_token
description: >-
Authentication method. `ssh` for deploy key, `https_token` for
deploy token/PAT.
example: ssh
cloneUrl:
type: string
description: Clone URL of the git repository (SSH or HTTPS)
example: git@github.com:org/repo.git
baseBranch:
type: string
description: The target branch for Omni pull requests.
example: main
branchPerPullRequest:
type: boolean
description: >-
If `true`, all pull requests will create a branch in Omni, even
those created outside of the tool.
example: false
gitFollower:
type: boolean
description: >-
If `true`, the shared model is read-only and can only be updated by
merging pull requests to the base branch.
example: false
gitServiceProvider:
type: string
enum:
- github
- gitlab
- azure_devops
- bitbucket
description: |
The git provider type.
- `github` - GitHub
- `gitlab` - GitLab
- `azure_devops` - Azure DevOps
- `bitbucket` - Bitbucket
example: github
modelPath:
type: string
nullable: true
description: Path to model files in the repository.
example: omni/blobs_r_us
publicKey:
type:
- string
- null
description: >
SSH public key for repository access (deploy key). Null for HTTPS
token auth (`authMethod: https_token`).
example: ssh-ed25519 AAAA...
requirePullRequest:
type: string
enum:
- always
- users-only
- never
description: |
Controls when pull requests are required for changes:
- `always` - Required for all changes
- `users-only` - Required only for user-initiated changes
- `never` - Never required
example: users-only
sshUrl:
type: string
deprecated: true
description: >
**Deprecated. Use `cloneUrl` instead**. SSH URL of the git
repository.
example: git@github.com:org/repo.git
webUrl:
type: string
nullable: true
description: Custom web URL for the git repository, or null if not set.
example: https://github.com/org/repo
webhookSecret:
type: string
description: >-
Webhook secret for signature verification. Only included if
requested via `?include=webhookSecret`.
webhookUrl:
type: string
description: Webhook URL to configure in your git provider.
example: https://app.omni.co/api/webhooks/model/...
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`
````