Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.auditynow.com/llms.txt

Use this file to discover all available pages before exploring further.

​
What Audity is, briefly

Audity is a B2B SaaS platform for AI consultants. It runs structured audits of a client’s business, surfaces opportunities and risks via AI synthesis, manages an inbox of inbound leads from public ReadyLink surveys, and remembers everything across engagements via a layer called Nucleus. If you’re a consultant inside the app, you upload documents, click “run audit,” review the output, ship deliverables. If you’re outside the app, you do the same things from your AI assistant. This site documents the agent API, the surface that lets external AI agents act on a consultant’s Audity workspace.

​
What the agent API is for

Three concrete outcomes a consultant gets when they wire an AI agent up to Audity:
  1. Run an audit without leaving your chat window. “Start an Audity project for , , . Run the analysis. Summarize the top three opportunities.” Three real API calls, one prompt, one paragraph back.
  2. Triage your lead inbox in 30 seconds. “Pull my Audity leads from this week scored above 70. Convert the top three into projects. Trigger analysis on each.” A workflow that used to be 15 minutes of dashboard clicking, done from Claude Desktop.
  3. Query your accumulated client knowledge from anywhere. “What do I remember about Acme’s stakeholder concerns? Are there patterns I’ve seen across other healthcare clients?” Nucleus, your persistent memory layer, becomes searchable from any AI assistant.
If those sound useful, start with the quickstart. If you want to know what’s under the hood first, keep reading.

​
How it works

┌──────────────────────────────────────────────────────────────────┐
│  Your AI assistant (Claude, ChatGPT, Cursor, n8n, custom)        │
└────────────────────────┬─────────────────────────────────────────┘
                         │ MCP (auto-generated by Mintlify)
                         ▼
┌──────────────────────────────────────────────────────────────────┐
│  docs.auditynow.com/mcp     +     llms.txt                       │
│  Tool surface, generated from the OpenAPI spec on this site      │
└────────────────────────┬─────────────────────────────────────────┘
                         │ HTTPS + Bearer PAT
                         ▼
┌──────────────────────────────────────────────────────────────────┐
│  Audity API (app.auditynow.com)                                  │
│  PAT resolves to your Clerk identity → tier + RLS gates apply    │
└──────────────────────────────────────────────────────────────────┘
Every agent call goes through the same permission stack that protects the web app:
  • Your PAT proves you are you (issued from your settings page; bcrypt-hashed at rest)
  • Your subscription tier gates which features are callable
  • Supabase Row-Level Security ensures the agent only sees data you own
  • Credit deductions apply normally, creating a project costs credits whether it’s clicked from the dashboard or invoked from Claude

​
Two ways to use the API

Through MCP (recommended). Most agent integrations should use the auto-generated MCP server at docs.auditynow.com/mcp. Drop that URL into Claude / ChatGPT / Cursor / n8n with your PAT, and every Audity endpoint becomes a tool the agent can call by name. Direct HTTP. For custom workflows, scheduled jobs, or non-MCP agents, call the REST endpoints directly with Authorization: Bearer aky_.... The full spec is at /api-reference/openapi.json, and there’s a curl-first walkthrough at API Quickstart.

​
What you can do today

CapabilityEndpoints
List, fetch, create, and patch projectsGET/POST /api/projects, GET/PATCH /api/projects/{id}
Trigger audit synthesis (the AI pipeline)POST /api/projects/{id}/audit-analysis
Read AI-generated opportunities and full deliverablesGET .../opportunities, GET .../deliverables
List leads from your ReadyLinks and convert themGET /api/lead-generation/leads, POST .../convert
Search and create Nucleus memoriesGET /api/nucleus/memories, POST /api/nucleus/memories
Submit text captures (transcripts, notes) and read extracted itemsPOST /api/nucleus/capture/note, GET /api/nucleus/captures/{id}
Read proactive insights generated by background jobsGET /api/nucleus/insights
Manage the lightweight contact CRMGET/POST/PATCH/DELETE /api/nucleus/contacts
Check your tier, credits, and current identityGET /api/user/{current,tier,credits}
The full path list and request/response shapes are in the API Reference.

​
What’s intentionally out of scope for v1

The agent surface is deliberately narrow. These belong to the web app, not the API:
  • Document upload. PDFs, transcripts, contracts go through the web app. Once uploaded, agents can read them via project detail and trigger analysis.
  • Streaming responses. Audity returns structured JSON, not chat tokens. Stream prose with your own LLM; use Audity for synthesis, memory, project state.
  • Deliverable document regeneration. The synthesis pipeline produces stakeholder memos and other deliverable docs once audit-analysis runs. Agents read them, they don’t trigger fresh generation in v1.
  • Web research. The route exists but isn’t agent-accessible in v1. Run it from the dashboard.
  • PAT management via PAT. Tokens are created and revoked from a browser session, not via the API itself.
  • Listing or managing ReadyLinks. Manage links from the web app; the lead listing endpoint accepts a staticSlugId filter so you can scope queries to a specific link.
If a workflow you need crosses one of these lines, tell us.

​
Two ways to connect

Claude

Add Audity as a remote MCP connector inside Claude Desktop, claude.ai, or Claude Code.

ChatGPT

Wire Audity into a Custom GPT via OpenAPI Actions.

Cursor

Drop the MCP server into Cursor’s tool palette.

n8n

Use the MCP Client node, or call endpoints from HTTP Request nodes.

​
What’s under the hood

If you’re building an integration:
  • The full API is documented as OpenAPI 3.1 at /api-reference/openapi.json
  • The MCP server is auto-generated by Mintlify from that spec, when we add an endpoint, it’s available as a new MCP tool on the next docs deploy
  • Auth is Bearer token (aky_<32 chars>) issued from your Audity settings page
  • The token resolver runs in middleware; tier and RLS enforcement happens in route handlers
Ready? Start with the quickstart →