Skip to main content

Semrush

Research keywords, domains and backlinks with Semrush's SEO data.

Connect it with: API key. Semrush's own documentation: https://developer.semrush.com/api/v3/get-started/api-units-balance/.

What agents can do​

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

  • Look up search volume, difficulty and CPC for keywords, and find related keywords.
  • Compare a domain's organic and paid keywords and traffic against competitors.
  • Read a domain's backlinks and referring domains.
  • Check how many API units are left before starting a large research task.

Before you start​

  • A Semrush Business subscription, or API units bought for your account. Pro and Guru plans have no API access.
  • A Jaah account. Anyone can add a personal secret; an organization secret needs an Org Owner or Admin.

Connect with Semrush​

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

Connect with an API key​

Find each value first:

  • API key: semrush.com > Subscription info > API units (semrush.com/accounts/subscription-info/api-units/), or My profile > API keys. API access needs a Business plan or purchased API units.

Then add it to Jaah:

  1. In Jaah, open Secrets, select New, and pick the Semrush 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 Semrush with an API key, not through an OAuth app.

Test the connection​

Select Test on the secret. Jaah calls Semrush's API once (GET https://www.semrush.com/users/countapiunits.html) with the stored values, and shows whether Semrush accepted it, or which value Semrush 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 Semrush secret org/semrush”.

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

Limitations​

  • Every report an agent pulls spends API units from your Semrush balance, priced per line returned. Ask agents for a limit (display_limit) on large reports.
  • Projects, Position Tracking and Site Audit data need the separate Projects API, which uses the same key.
  • The Test checks the key only: it calls the free balance check, which spends no units.
  • Agents can do only what the connected Semrush account allows.

Troubleshooting​

Test says Semrush rejected the API key (400)

The key was regenerated or mistyped. Copy it again from Subscription info > API units and select Replace on the secret.

An agent gets ERROR 132 :: API UNITS BALANCE IS ZERO

The account has no API units left. Buy units under Subscription info > API units, or wait for the monthly top-up.

An agent gets ERROR 50 :: NOTHING FOUND

Semrush has no data for that keyword or domain in the chosen database. Ask the agent to try another regional database, such as us or uk.

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

FAQ​

Does connecting cost API units?

No. Jaah's Test calls the free balance check.

Can agents see my Semrush projects?

Yes, through the Projects API with the same key, if your plan includes 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 Semrush account?

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