Skip to main content

Jaah

Lets agents call a Jaah control plane's API with a Jaah API key: tasks, projects, nodes and secrets.

Connect it with: API key. Jaah's own documentation: https://datatracker.ietf.org/doc/html/rfc6750.

What agents can do​

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

  • Create, read and update tasks and epics, and comment on them.
  • Read projects, nodes and worktrees to plan or report on work.
  • Start automations and schedules, and read what they did.
  • Reach another Jaah control plane, such as a separate organization or a self-hosted console.

Before you start​

  • A Jaah account in the organization: every member can hold Jaah API keys.
  • To create the key from this form: nothing else - choose New and Save makes a key with every permission you hold and no expiry.
  • To use a key you already have: its secret, copied when it was created or last rotated.
  • A Jaah account. Anyone can add a personal secret; an organization secret needs an Org Owner or Admin.

Connect with Jaah​

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

Connect with an API key​

Find each value first:

  • URL: The console's address, without a path. A new secret starts with the console you are using.
  • API key: A Jaah API key: Settings > API keys > New key, shown once. It starts with jaah_.
  • Key (optional): Filled by the form: the id of the API key the secret holds, so the key can be found in Settings > API keys.

Then add it to Jaah:

  1. In Jaah, open Secrets, select New, and pick the Jaah card.
  2. Name the secret and choose who can use it.
  3. Fill in URL, API key, 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 Jaah with an API key, not through an OAuth app.

Test the connection​

Select Test on the secret. Jaah calls Jaah's API once (GET <URL>/api/auth/me) with the stored values, and shows who it answered as, or which value Jaah 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, key_id.

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

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 Jaah 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 Jaah's side too, revoke or delete the key at Jaah.

Limitations​

  • A key acts as the person who made it, narrowed to the permissions ticked on it: work agents do is attributed to that person.
  • A key stops working when it is revoked or expires, or when its owner is disabled. It never does more than its owner can.
  • Keys never reach the routes that manage keys, sessions or sign-in, nor streams and WebSockets.
  • New is offered only for the console you are using: for another console, make the key there and paste it.
  • Agents can do only what the connected Jaah account allows.

Troubleshooting​

Test says Jaah rejected the API key (401)

The key was revoked, expired, rotated without overlap, or its owner is disabled. Make a new key in Settings > API keys and paste it, or choose New.

Test says Jaah rejected the API key (403)

The request came from an address outside the key's IP allowlist or the organization's. Add the control plane's address to the allowlist, or clear the key's allowlist.

Test says Jaah returned HTTP 404

The URL includes a path. Enter only the console's address, such as https://console.example.com.

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

FAQ​

Which person do agents act as?

The key's owner: the person who created it. Make the key from a dedicated account if you want agents' work attributed separately.

What does New create?

A key named after the secret, with every permission its owner holds, Org administration off and no expiry. It is listed in Settings > API keys, where it can be edited or revoked.

Does the key expire?

A key made by New does not. A key made in Settings > API keys lasts until the expiry chosen there.

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 Jaah account?

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