How to Find and Generate Your Synup API Key

Overview

Your Synup API key is what allows external tools like Claude Code, Cursor, Windsurf, and Codex to connect to your Synup account securely. You'll need it any time you're setting up a new MCP integration or connecting via the Synup API.

How to Generate an API Key

1. Log in to your Synup account
2. Click the Settings icon in the top-right corner of the navigation bar
3. Select Integrations from the menu
4. Enter a name for your API key — use something descriptive like "Claude Code" or "Cursor MCP" so you can identify it later
5. Click Generate
6. Your new API key will appear on screen — copy it immediately and store it somewhere safe

Important: Save Your Key Before Leaving the Page

Synup only shows the full API key once at the time of generation. If you navigate away without copying it, you will not be able to retrieve it again and will need to generate a new one.

Store it in a secure place such as a password manager or your team's secrets vault.

How to Use Your API Key

When connecting Synup MCP to an AI tool, you'll pass your API key as a request header in the following format:

X-api-key: YOUR_API_KEY_HERE

You'll also need to include a second header that sets the access mode:

X-access-mode: read

Use read for query-only access during testing, and write when you're ready to allow the AI to take actions on your behalf such as responding to reviews or posting content.

How to Rotate or Revoke a Key

If your API key is ever exposed — for example shared in a screenshot, pasted into a public document, or sent in a support ticket — you should rotate it immediately:

1. Go to Settings → Integrations
2. Locate the compromised key
3. Delete it and generate a new one
4. Update the key in any tools or config files where it was being used

FAQs

How many API keys can I have? You can generate multiple API keys, which is useful if you're connecting several different tools. Giving each key a distinct name makes it easier to track and revoke individual ones if needed.

Can I use the same API key across multiple tools? Yes, though it's better practice to create a separate key per tool so you can revoke access for one tool without affecting the others.

My API key stopped working. What should I check? Verify that the key hasn't been deleted or rotated under Settings → Integrations. Also check that you're passing it in the correct header format (X-api-key) with no extra spaces before or after the value.

Is my API key the same as my account password? No, but it carries the same level of access to your Synup data and should be treated with the same care. Never share it publicly or include it in shared documents or code repositories.