Generic API key
Store one API key for any service, with the header and prefix it is sent under, when no card fits.
Connect it with: API key. Generic API key's own documentation: https://datatracker.ietf.org/doc/html/rfc6750.
What agents can do
Connect Generic API key so the agents working your tasks can reach it. With it connected, they can:
- Call the API at the URL you saved, sending the key under the header and prefix you chose.
- Use the key in every task allowed to use the secret, without anyone pasting it into a prompt.
Before you start
- A key or token from the service, and its documentation for how the key is sent (a header such as Authorization or X-API-Key, and any prefix such as Bearer).
- When the whole organization reuses the same API: an Org Owner or Admin can define it once as a custom connector instead, under Secrets > Add secret > Custom category.
- A Jaah account. Anyone can add a personal secret; an organization secret needs an Org Owner or Admin.
Connect with Generic API key
Jaah connects to Generic API key with an API key, not with a sign-in button.
Connect with an API key
Find each value first:
- URL (optional): The API's root address, for example https://api.example.com/v1. Leave it blank for a key that names no host, such as one a Jaah feature reads; the Test then has nothing to call.
- API key: The key or token the service gave you, usually under its account, developer or API settings page. Paste the key alone, without a scheme word such as Bearer.
- Header name (optional): The HTTP header the API reads the key from, as its documentation names it (for example X-API-Key). Leave it blank to send the key in Authorization.
- Value prefix (optional): The word sent before the key, such as Bearer or Token. Leave it blank to send the key alone.
Then add it to Jaah:
- In Jaah, open Secrets, select New, and pick the Generic API key card.
- Name the secret and choose who can use it.
- Fill in URL, API key, Header name, Value prefix.
- 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 Generic API key with an API key, not through an OAuth app.
Test the connection
Select Test on the secret. Jaah makes one read-only call to Generic API key with the stored values and shows the result on the secret's page. Jaah also tests automatically when you save or reconnect.
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, header_name, value_prefix.
Tell the agent in your task description which secret to use, for example “use the Generic API key secret org/generic-api-key”.
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 Generic API key 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 Generic API key's side too, revoke or delete the key at Generic API key.
Limitations
- Jaah does not know the API's endpoints: agents work from the API's own documentation, so link it in the task.
- The Test calls one GET request on the URL and passes on any answer that is not a refusal, so it proves the host answered, not that the key works on every endpoint.
- Without a URL there is nothing to test, and the key stays usable only where the secret is read directly.
- Agents can do only what the connected Generic API key account allows.
Troubleshooting
The Test says the host rejected the request (401 or 403)
Check the key, then the header name and value prefix against the API's documentation. Many APIs expect X-API-Key with no prefix, others Authorization with Bearer.
Saving says the header name or value prefix is refused
Spell the header name as the API's documentation does, with no spaces or colon; Host, Content-Length and the other headers Jaah sets itself are refused. A prefix is one word, such as Bearer.
The Test says URL is required before testing
Add the API's https address in URL, or leave the key untested when a Jaah feature reads it directly.
Still stuck? Select Test and read the result: it names the value Generic API key refused and the status it answered.
FAQ
When should I use this card instead of a service's own card?
Only when the service has no card. A service's own card knows its address, how the key is sent and how to test it.
What is the difference from a custom connector?
This secret is yours alone, defined as you save it. A custom connector is defined once by an Org Owner or Admin, and every member connects to it.
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 Generic API key account?
Yes. Add one secret per account, each with its own name, and tell the agent which one to use.