How Do I Find and Use My Gumshoe API Key? – Gumshoe
Gumshoe has an API. It connects your audit data directly to your own workflows and systems, so you can build dashboards and combine your AI visibility data with the rest of your tech stack.
If you only need Visibility Audit data now and then, an export may be quicker. See How Do I Export a Gumshoe Visibility Audit to JSON, PDF, or CSV?
Do I have access to the API?
The API is included in the Playbook (also known as the Pro plan), and Gumshoe must enable API access first. If you're on the Playbook, ask for a human over chat or email support@gumshoe.ai, and we'll turn it on for your account.
The API isn't part of Starter or Build your own. You can move a Project to the Playbook from any plan at any time. See How do I upgrade my Project or change its plan?
What data can I pull through the API?
- Projects: every Project in a Workspace (organization in the API), and each Project's details, with links to its audits.
- Visibility Audit (report in the API) and Pulse Audit runs: run history, run summaries, the raw questions and AI model answers, and the cited URLs behind your Citations page.
- Sentiment Audit: runs, scores, answers, themes, and raw data.
- Content Audit: recommendations, grouped by Topic.
- Technical Audit: both versions, including every check, category score, and recommendation. The older version appears as page audits in the API.
- Generated content: the content you have created in Gumshoe.
Can I create a Visibility Audit or start a run through the API?
Yes. You can create a Visibility Audit and start a run through the API. Runs started through the API are billed the same as runs started in Gumshoe, and starting one needs a key with billing permission.
What can't the API do?
- Edit Personas, Prompts, Topics, or competitors
- Create a Project
- Start a Sentiment, Content, or Technical Audit
- Generate content
- Delete anything
- Return the Citation Audit's page details and filters. Cited URLs are available through the Visibility Audit runs.
How do I find my API key?
- Click the dropdown in the top-left corner of your screen.
- Next to your Workspace name, click the small settings icon to open Workspace Settings.
- In the left-side menu, scroll to "Manage workspace" and select API Keys.
A Workspace admin creates keys and gives each one a role: Admin, Member, or Viewer. A Viewer key is enough to read your data. Keys can be disabled, and they can expire.
If you don't see API Keys:
- API access may not be enabled for your account yet. Ask for a human over chat or email support@gumshoe.ai to request it.
- You may be in the wrong Workspace.
- You may have limited access to the Workspace you are in.
If you still don't see it after checking these, ask for a human over chat or email support@gumshoe.ai and we'll investigate.
Where is the API documentation?
You can open the API documentation from the API Keys page or here. Results come back in pages of up to 1,000 items, with a continuation token for the next page.
How do I fix a 401 error when using the API?
A common cause of a 401 error on the runs endpoint is passing the run's ID in the {ordinal} placeholder. That field expects the run's ordinal number (1, 2, 3, and so on, based on run order), not the runId.
Can I connect Gumshoe to an AI tool instead?
Yes. On the Playbook, you can connect AI tools such as Claude and ChatGPT directly to your Visibility Audit data through our MCP connection, which is in beta. See Can I connect Gumshoe to Claude, ChatGPT, or another AI tool?
What should I do next?
Once your key is set up, start with the Projects list to find the Project you want, then follow its links to the audits you need. If you'd rather work inside an AI tool, see Can I connect Gumshoe to Claude, ChatGPT, or another AI tool?