Omni Developers

API Keys

Choose, name, copy, and revoke an Omni Developer Preview key.

Omni's Access Token Manager creates named scoped credentials for the Developer API.

  1. Select Developer Preview.
  2. Use a distinct name such as Local research agent or CI smoke test.
  3. Create the key and copy the secret once.
  4. Export it as OMNI_API_KEY.
  5. Revoke it when the integration no longer needs access.

The Developer Preview profile includes stateful tasks, workspace history, encrypted Files, Vault, citations, and file deletion. Use a separate key per environment so one integration can be revoked without disrupting another.

The older General API key profile exists for compatibility integrations. New stateful integrations should choose Developer Preview.

Authentication

Create and safely use scoped personal access tokens for the Omni Developer Preview.

Tasks

Send messages into an ongoing Omni workspace and follow asynchronous results.

On this page

Recommended setup