Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/omnigent-ai/omnigent/llms.txt

Use this file to discover all available pages before exploring further.

omnigent setup is the interactive tool for managing model credentials. It walks you through adding a credential, setting a default, or removing one — organized by agent. Credentials are stored securely and are per-agent, so a Claude default and a Codex default coexist without conflict.
On first run, Omnigent picks up model credentials already in your environment (ANTHROPIC_API_KEY, OPENAI_API_KEY, or a claude / codex CLI you’re already logged into) and offers one as the default.

​
Credential types

Omnigent works with four kinds of credentials:
IconKindWhat it is
🔑API keyA first-party vendor key for Anthropic, OpenAI, or similar providers
🎟️SubscriptionA Claude Pro/Max or ChatGPT plan, used via the official claude / codex CLIs
🌐GatewayAny OpenAI- or Anthropic-compatible base_url and key (OpenRouter, LiteLLM, Ollama, vLLM, Azure)
🧱DatabricksA Databricks workspace profile (requires the databricks extra)

​
Running setup

omnigent setup
The interactive walkthrough lets you:
  • Add a new credential (API key, subscription, gateway, or Databricks profile)
  • Set the default credential for each agent
  • Remove a credential
Defaults are per agent — you can have a Claude default and a Codex default simultaneously with no conflict. You can also switch models in the middle of any session with the /model chat command.

​
Switching models mid-session

Type /model in any agent chat to switch the active model without restarting the session. This is also how you unblock a session that has hit the cost_budget hard limit — switch to a cheaper model and tool calls are allowed again.

​
Gateway providers

When you add a Gateway credential, omnigent setup asks for a base URL and an API key. The base URL format depends on which agent you point it at:
ProviderFor agentBase URLKey
OpenRouterClaude Code (claude-sdk)https://openrouter.ai/apisk-or-…
OpenRouterCodex / OpenAI Agentshttps://openrouter.ai/api/v1sk-or-…
Ollama (local)Codex / OpenAI Agentshttp://localhost:11434/v1any value
For Claude Code, point at OpenRouter’s Anthropic-compatible endpoint (…/api, not …/api/v1). For Codex and the OpenAI-agents harness, use the OpenAI-compatible …/api/v1.

​
Databricks workspace

To use a Databricks workspace as your model provider:
1

Install the Databricks extra

pip install "omnigent[databricks]"
# or with uv:
uv tool install "omnigent[databricks]"
2

Sign in to your Databricks workspace

databricks auth login
3

Declare the auth block in your agent YAML

executor:
  harness: claude-sdk
  model: databricks-claude-sonnet-4-6
  auth:
    type: databricks
    profile: oss     # your Databricks CLI profile name

​
Environment variables

Omnigent reads standard API key environment variables on first run and offers them as credential defaults:
VariableProvider
ANTHROPIC_API_KEYAnthropic (Claude)
OPENAI_API_KEYOpenAI (GPT, Codex)
Set either variable in your shell before running omnigent and it will be detected automatically. You can also add them explicitly through omnigent setup at any time.

Build docs developers (and LLMs) love

Get started for freeTalk to us