Generate an API key

API access lets you script anything you can do in the dashboard: trigger audits, fetch rankings, submit URLs to IndexNow, post conversions, stream events. To use the API you need a Client ID and a Client Secret. You generate both from Settings → API Credentials.

Plan requirement

API access is included on Management and CEO plans. The page tells you so if you're on Free, Marketing or trial – you'll see an Upgrade prompt instead of the Generate button.

Generate your credentials

1. Go to Settings → API Credentials.
2. Click Generate credentials.
3. A yellow box appears with your Client ID and Client Secret. Both are shown in full this once.
4. Copy the Client Secret immediately. It will be masked the moment you leave this page or click Generate again.
5. Store the Secret in your password manager or your environment-variable system.

Using your credentials

The REST API expects the Client Secret as a bearer token. The Client ID is implicit (we derive your workspace from the Secret).

bash
curl https://api.semoptimiser.com/v1/audits \
  -H "Authorization: Bearer sk_live_yourSecretHere" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com", "depth": 3}'

Regenerate the Secret

If you lose the Secret or suspect it leaked, regenerate. The old Secret is invalidated within a minute and the new one takes effect immediately. You'll need to update every script or system that used the old Secret – no grace period.

Revoke entirely

Click Revoke on the credentials page. Both the Client ID and Secret are invalidated. The page resets to "No API credentials yet" and any script using them returns 401. You can generate fresh credentials at any time.

Rate limits

Every response includes RateLimit-* headers so you can back off gracefully. If you're consistently hitting the cap, contact support – we can lift limits per workspace.

Logging and audit trail

On the CEO plan, every API call is logged with timestamp, endpoint, source IP and response code. Filter and export from Settings → Audit logs. Useful for compliance reviews and for tracking down "who deleted that?".