> ## 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.
# Open or close a branch to viewers
>
Opening a branch with this endpoint requires permission to edit every model in the branch.
Closing a branch only requires permission to edit the branch on one of its member models.
Open a branch to Viewers and Restricted Queriers - including embed users - so they see the branch's content instead of production, or close it again. See [Opening a branch to viewers](/content/develop/branch-mode#opening-a-branch-to-viewers) for more information.
## OpenAPI
````yaml /api/openapi.yaml patch /v1/branches/{branchId}
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: Who Am I
description: Inspect your own user permissions
- name: AI
description: AI-powered query generation
- name: AI Credit Controls
description: Manage organization-level AI credit usage
- name: AI Credit Usage
description: Monitor AI credit usage
- name: AI Evals
description: >-
Manage prompt sets and runs used to score AI quality against curated
prompt suites.
- name: AI Model Suggestions
description: Manage AI-generated suggestions for shared models
- name: AI Routines
description: >-
Manage Routines, which are scheduled, recurring AI-powered tasks that run
automatically on your data
- name: Apps
description: Draft and publish app documents.
- name: App downloads
description: Download apps as PNG, PDF, XLSX, or CSV files
- name: Branches
description: List branches and open or close them to Viewers and Restricted Queriers
- name: Documents v2
description: >
A draft-based workflow for creating and editing documents: create a
document, patch a draft, then publish.
- name: Documents
description: Create, retrieve, and manage documents
- name: API Tokens
description: >-
Manage API tokens (Organization keys, Personal Access Tokens, MCP OAuth
grants)
- name: IP Allowlist
description: Manage the organization's IP allowlist
- name: Connections
description: Manage database connections
- name: Connection environments
description: Manage connection environments database connections
- name: Color Palettes
description: Manage custom chart color palettes
- 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: 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: Embed
description: Manage embed sessions
- name: Labels
description: |
Manage labels in the organization
- name: Folders
description: Create and organize content folders
- name: Folder favorites
description: Favorite and unfavorite folders
- name: Folder labels
description: Apply and manage labels on 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: Skills
description: >-
Manage skills, the saved slash-command instructions the Omni AI assistant
runs
- 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/branches/{branchId}:
patch:
tags:
- Branches
summary: Open or close a branch to viewers
description: >
Opening a branch with this endpoint requires permission to edit every model in the branch.
Closing a branch only requires permission to edit the branch on one of its member models.
Open a branch to Viewers and Restricted Queriers - including embed users
- so they see the branch's content instead of production, or close it
again. See [Opening a branch to
viewers](/content/develop/branch-mode#opening-a-branch-to-viewers) for
more information.
operationId: setBranchOpenToViewers
parameters:
- $ref: '#/components/parameters/branchIdPath'
- $ref: '#/components/parameters/userId'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- openToViewers
properties:
openToViewers:
type: boolean
description: >
`true` to open the branch to Viewers and Restricted
Queriers, `false` to close it.
example:
openToViewers: true
responses:
'200':
description: The branch was opened or closed successfully.
content:
application/json:
schema:
type: object
properties:
branch:
type: object
properties:
id:
type: string
format: uuid
description: The organization-wide branch ID.
name:
type: string
description: The branch's name.
openToViewers:
type: boolean
description: The branch's new state.
success:
type: boolean
description: Whether the operation succeeded.
example:
branch:
id: 123e4567-e89b-12d3-a456-426614174001
name: feature/new-metrics
openToViewers: true
success: true
'400':
description: |
Bad Request
Possible error messages:
- `openToViewers` is missing or isn't a JSON boolean
- An Organization API key was used without a `userId`
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError400'
'403':
description: >
Forbidden
Possible error messages:
- `Opening a branch to viewers needs permission to edit every model
in it`
- Closing a branch to viewers needs permission to edit the branch on
at least one of its models
- A Personal Access Token was used with a `userId` naming a
different member
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError403'
'404':
description: >
Not Found
Possible error messages:
- `Branch with id does not exist` - the ID names a
retired branch, a model-level layer ID rather than an org-wide
branch ID, or a branch in another organization
- `User with id does not exist` - an Organization API key
named a `userId` who hasn't accepted their invitation
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError404'
'405':
$ref: '#/components/responses/ApiError405'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
security:
- bearerAuth: []
components:
parameters:
branchIdPath:
name: branch_id
in: path
schema:
type: string
format: uuid
example: 123e4567-e89b-12d3-a456-426614174001
required: true
description: >
The organization-wide branch ID (`orgBranchId`). This isn't the same as
the ID of a branch model.
userId:
name: userId
schema:
type: string
format: uuid
required: false
description: >
**Organization API key required.** The membership ID of the user to act
as.
in: query
schemas:
ApiError400:
type: object
properties:
detail:
type: string
description: Human-readable error message describing what went wrong.
status:
type: integer
description: HTTP status code of the error.
example: 400
required:
- detail
- status
ApiError403:
type: object
properties:
detail:
type: string
description: Human-readable error message describing what went wrong.
status:
type: integer
description: HTTP status code of the error.
example: 403
required:
- detail
- status
ApiError404:
type: object
properties:
detail:
type: string
description: Human-readable error message describing what went wrong.
status:
type: integer
description: HTTP status code of the error.
example: 404
required:
- detail
- status
Error:
type: object
properties:
error:
type: string
description: HTTP response code for the error
example:
message:
type: string
description: Detailed error description
example:
responses:
ApiError405:
description: Method Not Allowed
content:
application/json:
schema:
type: object
required:
- detail
- status
properties:
detail:
type: string
description: Human-readable error message describing what went wrong.
example: Method Not Allowed
status:
type: integer
description: HTTP status code of the error.
example: 405
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#token-types).
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`
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.