Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Important
Omnigent is in Beta. For the open-source documentation, see the Omnigent documentation.
Omnigent runs as a managed deployment on Azure Databricks. The server that coordinates your sessions is managed for you, and you sign in with your Azure Databricks workspace identity. This page covers the setup that is specific to Azure Databricks. See the open-source Omnigent documentation for more information about Omnigent features and capabilities.
Prerequisites
You must have:
- The Omnigent preview enabled for your workspace. See Manage workspace-level previews.
- A workspace in a region that supports Databricks Unity AI Gateway. See Databricks feature availability by region.
To install Omnigent using the CLI, you must have:
- Python 3.12+
- Node.js 22 LTS with npm and tmux
Choose a host
Omnigent always runs on your managed Azure Databricks deployment server. The host that executes your agent is your own machine. You install the Omnigent CLI and register your laptop or a VM as a host so agents can access local files, tools, or networks. A local host is available only while your machine and the omni host process are running.
You sign in with your Azure Databricks workspace identity, and your sessions appear in the <workspace-url>/omnigent UI where they can be shared with other workspace users.
Launch Omnigent on your own machine
Install the Omnigent CLI and register your laptop or a VM as a host. The machine you register becomes the execution environment for your agents, so choose the machine that has access to the tools, files, and network your agent needs. A local host is available only while your machine and the omni host process are running.
Install Omnigent with the
databricksextra, which adds the managed-platform integration.Install script
curl -fsSL https://omnigent.ai/install.sh | sh -s -- --extra "databricks"UV
uv tool install "omnigent[databricks]"Pip
pip install "omnigent[databricks]"Set up model credentials. Run
omni setup:omni setup
Credentials are scoped per harness, so you must select a harness, then choose how to provide its credentials.
- To invoke your workspace's Foundation Model APIs, choose Databricks and enter your workspace URL. This signs you into the workspace and routes that harness's model calls through Databricks Unity AI Gateway, so there are no API keys to manage and usage is governed and billed there.
- Otherwise, provide your own API key, subscription, or gateway.
Sign in with your Azure Databricks identity and register the machine as an Omnigent host:
omni login <workspace-url> omni host --server <workspace-url>In your web browser, go to
<workspace-url>/omnigent.Select New session.
Open the host picker and select the machine you registered. The host you select determines the execution environment the agent runs in, so pick the host that has access to the tools, files, and network your agent needs.
Describe a task in the composer and send it to start the session.
Connect the desktop app
The Omnigent desktop app is optional and only available on macOS. Install the desktop app, then after you have created a host, select Connect to new server in the app and enter your workspace URL.