Skip to main content

​
API keys

API keys authenticate the CLI, SDK, and HTTP API.

​
Create a key

  1. Sign in at app.omium.ai
  2. Open API Keys
  3. Create a new key and copy it (keys start with omium_)

​
Use the key

  • CLI: run omium init (recommended)
  • SDK: call omium.init() after omium init, or pass api_key=...
  • HTTP: send the key in X-API-Key (see API overview)

​
Billing and usage

In the dashboard you can review balance, usage, and per-run cost. You can also query via:
  • the Billing API
  • the CLI (where available): omium billing balance, omium billing usage

​
Good practices

  • Keep keys out of source control (use omium init or environment variables).
  • In CI, prefer OMIUM_API_KEY and OMIUM_API_URL environment variables.
  • Rotate keys when team members change or when a key is exposed.

​
Next steps

Configure

Where config is stored and how env overrides work.

Automations dashboard

Projects, runs, and cost.