1) Create an API key
- Sign in at app.omium.ai
- Open API Keys (or Settings → API Keys)
- Create a key and copy it
Keys look like omium_.... Treat them like passwords.
Run the interactive setup once. It verifies your key and stores config locally.
You’ll be prompted for:
- API key
- API URL (use
https://api.omium.ai for hosted Omium)
Do not add /api/v1 to the API URL in the CLI. The CLI appends it when calling endpoints.
3) Where config is stored
After omium init, configuration is written to:
- macOS / Linux:
~/.omium/config.json
- Windows:
%USERPROFILE%\\.omium\\config.json
4) Environment variables (CI-friendly)
Environment variables override the config file. This is the preferred pattern for CI/CD and servers.
macOS / Linux
Windows (PowerShell)
export OMIUM_API_KEY=omium_your_key_here
export OMIUM_API_URL=https://api.omium.ai
$env:OMIUM_API_KEY = "omium_your_key_here"
$env:OMIUM_API_URL = "https://api.omium.ai"
5) Next step
Run your first workflow locally:
