Data is opt-in: nothing exists until you track it. Track an account or video, the
first scrape runs in the background, and metrics populate over the next few hours,
then refresh daily. See Data freshness.
Prerequisites
- A CreatorAudit account. Sign up if you don’t have one.
- An API key for the agent and API tracks — create one on the API keys page (shown once; keep it secret). Reads work with any key; tracking, creating, and deleting need a
write-scoped key.
- AI agent (MCP)
- API
- Dashboard
Connect an AI client to the hosted MCP server at
https://mcp.creatoraudit.com/mcp and drive CreatorAudit in natural language — nothing to install or run. Authenticate with your API key.1
Add the server to your client
Fastest path — Claude Code:Other clients:
- Codex —
codex mcp add creatoraudit --url "https://mcp.creatoraudit.com/mcp?api_key=YOUR_API_KEY" - VS Code —
code --add-mcp '{"name":"creatoraudit","type":"http","url":"https://mcp.creatoraudit.com/mcp?api_key=YOUR_API_KEY"}' - Cursor — add it from Cursor’s Settings → MCP, or use the one-click Add to Cursor button on your dashboard’s API keys page.
- Claude Desktop / ChatGPT — add a custom connector with the URL
https://mcp.creatoraudit.com/mcp?api_key=YOUR_API_KEY.
Authorization: Bearer header, an x-creatoraudit-api-key header, or an ?api_key= URL query parameter (a header wins, and is safer than a URL). Restart the client fully after editing config. Full details in the MCP guide.2
Verify the connection
Ask the agent “which organization is my CreatorAudit key for?” — it runs
get_api_key_info and returns your organization. You’re connected.3
Track something and read it back
Ask the agent to track an Instagram or TikTok account (e.g. “track the TikTok account
nasa”). The first scrape runs in the background — metrics land over the next few hours, so check back rather than expecting them instantly.Full MCP guide
Every tool, the auth model, the docs MCP server, and building a custom server.
Next steps
Key concepts
Accounts, creators, videos, and how analytics are modeled.
Build with agents
MCP, generating tools from the OpenAPI spec, and end-to-end recipes.
API reference
Every endpoint with a live playground.
Code examples
Ready-to-run snippets in cURL, Python, and TypeScript.
- Paginate — pass
limit(1–200) and the previous response’spagination.next_cursoras thecursorquery parameter; whenhas_nextisfalse, you’ve reached the end. See Pagination. - Handle errors — failures return RFC 9457 problem details. See Errors.
Need help? Email support@creatoraudit.com.