Skip to main content

Clay

Read and run Clay workspaces, tables and enrichments with a Clay API key.

Connect it with: API key. Clay's own documentation: https://developers.clay.com/public-api/quickstart.

What agents can do​

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

  • Read the workspaces, tables and rows the key's user can see.
  • Add rows to a table so Clay's enrichment columns run on them.
  • Read enriched results back, for example the work email and company size Clay found for a lead.

Before you start​

  • A Clay account with access to the workspace agents should use.
  • A Jaah account. Anyone can add a personal secret; an organization secret needs an Org Owner or Admin.

Connect with Clay​

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

Connect with an API key​

Find each value first:

  • API key: In Clay, open your workspace settings, select API and CLI, open the API keys tab, select Create API key, name it Jaah and copy the key (Clay shows it once).

Then add it to Jaah:

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

Test the connection​

Select Test on the secret. Jaah calls Clay's API once (GET https://api.clay.com/public/v0/me) with the stored values, and shows who it answered as, or which value Clay 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: api_key.

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

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

Limitations​

  • A key carries the permissions of the user who created it, in that user's workspaces only.
  • Enrichments that agents trigger spend your Clay credits like they do in the app.
  • Clay's public API is versioned v0: Clay may change endpoints, and agents follow its current reference.
  • Agents can do only what the connected Clay account allows.

Troubleshooting​

Test says Clay rejected the API key (401)

The key was deleted or mistyped. Create a new one under API and CLI > API keys and select Replace on the secret.

Test says Clay rejected the API key (403)

The key's user lost access to the workspace. Ask a workspace admin to restore the access, or create the key as a user who has it.

An agent gets 429 Too Many Requests

Clay throttles bursts per key. Ask the agent to send rows in batches and retry after the wait Clay returns.

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

FAQ​

Which account does Test show?

The email (or name) of the Clay user who created the key, read from Clay's /me endpoint.

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

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