> ## 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.

# branch

> Starts the embed session on a modeling branch instead of the published model.

Use this parameter to show embedded content as it looks on a [modeling branch](https://docs.omni.co/content/develop/branch-mode.md), for example to review model changes before you merge them.

> [!NOTE]
>
> The value is the branch **name**, not the branch ID. If the name does not match a branch in your organization, or the embed user cannot use the branch, the content loads from the published model.

## Syntax

```markdown theme={null}
branch=<branch_name>
```

## Properties

**branch** `string`

The name of an existing branch. URL-encode special characters, for example `/` becomes `%2F`.

## Examples

```markdown title="Start the session on the staging branch" theme={null}
branch=staging
```

```markdown title="Start the session on a branch named feature/new-metrics" theme={null}
branch=feature%2Fnew-metrics
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.