Create or update a pull request for a model branch

curl --request POST \
  --url https://{instance}.omniapp.co/api/v1/models/{modelId}/git/commit \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "branch_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "commit_message": "Add new customer dimension",
  "allow_branch_exists": true,
  "require_branch_exists": false
}
'

import requests

url = "https://{instance}.omniapp.co/api/v1/models/{modelId}/git/commit"

payload = {
    "branch_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "commit_message": "Add new customer dimension",
    "allow_branch_exists": True,
    "require_branch_exists": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    branch_id: 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
    commit_message: 'Add new customer dimension',
    allow_branch_exists: true,
    require_branch_exists: false
  })
};

fetch('https://{instance}.omniapp.co/api/v1/models/{modelId}/git/commit', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{instance}.omniapp.co/api/v1/models/{modelId}/git/commit",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'branch_id' => 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
    'commit_message' => 'Add new customer dimension',
    'allow_branch_exists' => true,
    'require_branch_exists' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{instance}.omniapp.co/api/v1/models/{modelId}/git/commit"

	payload := strings.NewReader("{\n  \"branch_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n  \"commit_message\": \"Add new customer dimension\",\n  \"allow_branch_exists\": true,\n  \"require_branch_exists\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{instance}.omniapp.co/api/v1/models/{modelId}/git/commit")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"branch_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n  \"commit_message\": \"Add new customer dimension\",\n  \"allow_branch_exists\": true,\n  \"require_branch_exists\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{instance}.omniapp.co/api/v1/models/{modelId}/git/commit")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"branch_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n  \"commit_message\": \"Add new customer dimension\",\n  \"allow_branch_exists\": true,\n  \"require_branch_exists\": false\n}"

response = http.request(request)
puts response.read_body

{
  "pr_url": "https://github.com/myorg/repo/compare/main...feature?expand=1",
  "git_sha": "abc123def456",
  "in_sync": true,
  "did_sync": true
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

Git

Create or update a pull request for a model branch

This endpoint requires Modeler or Connection Admin permisisons.

Push a branch’s model contents to Git and create or update 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

POST

models

{modelId}

git

commit

Create or update a pull request for a model branch

curl --request POST \
  --url https://{instance}.omniapp.co/api/v1/models/{modelId}/git/commit \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "branch_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "commit_message": "Add new customer dimension",
  "allow_branch_exists": true,
  "require_branch_exists": false
}
'

import requests

url = "https://{instance}.omniapp.co/api/v1/models/{modelId}/git/commit"

payload = {
    "branch_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "commit_message": "Add new customer dimension",
    "allow_branch_exists": True,
    "require_branch_exists": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    branch_id: 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
    commit_message: 'Add new customer dimension',
    allow_branch_exists: true,
    require_branch_exists: false
  })
};

fetch('https://{instance}.omniapp.co/api/v1/models/{modelId}/git/commit', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{instance}.omniapp.co/api/v1/models/{modelId}/git/commit",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'branch_id' => 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
    'commit_message' => 'Add new customer dimension',
    'allow_branch_exists' => true,
    'require_branch_exists' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{instance}.omniapp.co/api/v1/models/{modelId}/git/commit"

	payload := strings.NewReader("{\n  \"branch_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n  \"commit_message\": \"Add new customer dimension\",\n  \"allow_branch_exists\": true,\n  \"require_branch_exists\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{instance}.omniapp.co/api/v1/models/{modelId}/git/commit")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"branch_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n  \"commit_message\": \"Add new customer dimension\",\n  \"allow_branch_exists\": true,\n  \"require_branch_exists\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{instance}.omniapp.co/api/v1/models/{modelId}/git/commit")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"branch_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n  \"commit_message\": \"Add new customer dimension\",\n  \"allow_branch_exists\": true,\n  \"require_branch_exists\": false\n}"

response = http.request(request)
puts response.read_body

{
  "pr_url": "https://github.com/myorg/repo/compare/main...feature?expand=1",
  "git_sha": "abc123def456",
  "in_sync": true,
  "did_sync": true
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

Authorizations

Authorization

string

header

required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

modelId

string<uuid>

required

The unique identifier of the shared model.

Body

application/json

branch_id

string<uuid>

required

UUID of the Omni branch to commit.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

commit_message

string

required

Commit message for the git commit.

Example:

"Add new customer dimension"

allow_branch_exists

boolean

default:true

Set false to fail if git branch already exists (Create-only mode).

Example:

true

require_branch_exists

boolean

default:false

Set true to fail if git branch doesn't exist (Update-only mode).

Example:

false

Response

Commit operation completed successfully

pr_url

string

URL of the created or updated pull request.

Example:

"https://github.com/myorg/repo/compare/main...feature?expand=1"

git_sha

string

The git SHA of the commit.

Example:

"abc123def456"

in_sync

boolean

Whether the shared model is currently in sync with its configured default git branch.

Example:

true

did_sync

boolean

Whether a sync operation was performed between the shared model and its configured default git branch.

Example:

true

Sync model with Git repository

Migrate a model

⌘I

Getting started

AI APIs

API token APIs

Connection APIs

Content APIs

Dashboard APIs

Document APIs

Folder APIs

Label APIs

Model APIs

Query APIs

Schedule APIs

Upload APIs

User APIs

User group APIs

Create or update a pull request for a model branch

Authorizations

Path Parameters

Body

Response