Skip to main content

Omni

Lets agents query Omni models, read documents and dashboards, and manage content through the Omni API.

Connect it with: API key. Omni's own documentation: https://docs.omni.co/docs/API/authentication.

What agents can do​

Connect Omni so the agents working your tasks can reach it. With it connected, they can:

  • Run queries against an Omni model and read the results.
  • List models, topics, documents and dashboards, and read their definitions.
  • Create, update or move documents and folders.
  • Manage users and groups with an organization key (SCIM).

Before you start​

  • An Omni organization and its address.
  • An Organization Admin to create an organization API key, or the Personal access tokens setting turned on for personal keys.
  • A Jaah account. Anyone can add a personal secret; an organization secret needs an Org Owner or Admin.

Connect with Omni​

Jaah connects to Omni with an API key, not with a sign-in button.

Connect with an API key​

Find each value first:

  • Instance URL: The address you open Omni at, such as https://yourcompany.omniapp.co, with no path after it.
  • API key: Omni > Settings > API Access > New API key (an Organization Admin's organization key), or your profile > Personal access tokens for a key that acts as you; copy it when it is shown.

Then add it to Jaah:

  1. In Jaah, open Secrets, select New, and pick the Omni card.
  2. Name the secret and choose who can use it.
  3. Fill in Instance URL, API key.
  4. Select Save. Jaah tests the secret straight away (see Test the connection).

Jaah encrypts what you type and never shows it again — not to you, and not to an admin.

Use your own OAuth app​

Not used: Jaah connects to Omni with an API key, not through an OAuth app.

Test the connection​

Select Test on the secret. Jaah calls Omni's API once (GET <Instance URL>/api/v1/models) with the stored values, and shows whether Omni accepted it, or which value Omni refused and the status it answered. Jaah also tests automatically when you save or reconnect.

The last result and its time stay on the secret's page, so you can see whether it still works without testing again.

Who can use it​

Every secret has an owner, and the owner decides who can use it:

  • Personal — only your own tasks can use it. This is the default.
  • Organization — every task in the organization can use it. Only Org Owners and Admins can choose this.
  • Attached to a project — every task on that project can use it, whoever started the task. See Attach a secret to a project.

More on owners and access: How secrets work.

Use it in an agent session​

An agent asks for the secret with its credential_get tool, by the secret's path, when it needs it, and gets the values for that one call. The path is the owner's prefix and the secret's name:

  • org/<name> for an organization secret,
  • projects/<project>/<name> for one attached to a project,
  • me/<name> for your personal one.

A key connection hands the agent its fields: base_url, api_key.

Tell the agent in your task description which secret to use, for example “use the Omni secret org/omni”.

Manage, rotate or disconnect​

Everything is on the secret's page under Secrets:

  • Rotate a key: create a new key at the vendor first, then select Replace on the secret and paste it. Revoke the old key at Omni once the test passes. Steps: Replace or delete a secret.
  • Disconnect: select Delete. The stored values are destroyed and agents lose access on their next call. To end access at Omni's side too, revoke or delete the key at Omni.

Limitations​

  • An organization API key has admin-level access to the whole organization; prefer a personal access token to keep agents to one person's access.
  • Omni rate-limits its API per organization; a burst of agent queries can be answered with 429.
  • Agents can do only what the connected Omni account allows.

Troubleshooting​

Test says Omni rejected the API key (401)

The key is wrong, expired or was deleted. Create a new one in Omni > Settings > API Access (or your profile's personal access tokens), select Replace on the secret, and paste it.

Test says Omni returned HTTP 404

The Instance URL is not your Omni root. Use the address you open Omni at, such as https://yourcompany.omniapp.co, with no path after it.

Test says Omni rejected the API key (403)

A personal access token cannot reach that endpoint. Give the token's owner access to the model, or use an organization key.

Still stuck? Select Test and read the result: it names the value Omni refused and the status it answered.

FAQ​

Organization key or personal access token?

A personal access token acts as you and sees only what you can; an organization key acts as an admin. Use the narrowest one that lets agents do the task.

Can Jaah or an admin see the key or token?

No. Jaah stores it encrypted and never shows it again. Only the tasks allowed to use the secret receive it, at the moment they ask for it.

Can I connect more than one Omni account?

Yes. Add one secret per account, each with its own name, and tell the agent which one to use.