# Audity for Agents

> Connect AI agents (Claude, ChatGPT, Cursor, n8n) to Audity. Run audits, fetch deliverables, and query Nucleus from outside the platform.

## Docs

- [API Quickstart (curl)](https://docs.auditynow.com/api-quickstart.md): Verify your token and run a real audit, end to end, from a terminal.
- [Create a new Personal Access Token (browser session only)](https://docs.auditynow.com/api-reference/account/create-a-new-personal-access-token-browser-session-only.md): Creates a new PAT for the authenticated user. The plaintext token is returned ONLY in this response, it cannot be retrieved later. Store it immediately.
- [Credits remaining + reset date](https://docs.auditynow.com/api-reference/account/credits-remaining-+-reset-date.md): Returns the user's full credit balance, allocation, usage, and the next reset date. Each project creation costs 1,000 credits. Call this before batch operations to avoid running out mid-flow.
- [Current subscription tier](https://docs.auditynow.com/api-reference/account/current-subscription-tier.md): Returns the user's current Audity subscription tier. Use this to predict whether a tier-gated operation will succeed before calling it. Public pricing names can change faster than API enum names, so use this endpoint and any `requiredTier` field in 403 responses as the source of truth for a specific…
- [Identity check](https://docs.auditynow.com/api-reference/account/identity-check.md): Returns the identity associated with the current Personal Access Token. Use this once at the start of a session to confirm authentication is working.
- [List the user's Personal Access Tokens (browser session only)](https://docs.auditynow.com/api-reference/account/list-the-users-personal-access-tokens-browser-session-only.md): Returns the metadata for active (non-revoked) PATs belonging to the authenticated user. Plaintext tokens are NEVER returned, only `tokenPrefix` (first 6 chars) for visual identification.
- [Revoke a Personal Access Token (browser session only)](https://docs.auditynow.com/api-reference/account/revoke-a-personal-access-token-browser-session-only.md): Soft-deletes (revokes) a PAT by setting its `revoked_at` timestamp. Revocation is permanent, the user cannot un-revoke. Future requests carrying this token will fail authentication.
- [Create a new assessment config template](https://docs.auditynow.com/api-reference/assessment-configs/create-a-new-assessment-config-template.md): Creates a new assessment configuration template. This endpoint ONLY creates templates (isTemplate is always true). Working configs are managed via the Audity UI. Returns 402 QUOTA_EXCEEDED if template limit is reached.
- [Delete an assessment config](https://docs.auditynow.com/api-reference/assessment-configs/delete-an-assessment-config.md): Hard-deletes an assessment config. Returns 204 on success. Returns 404 if the config doesn't exist or doesn't belong to the caller.
- [Fetch an assessment config with questions](https://docs.auditynow.com/api-reference/assessment-configs/fetch-an-assessment-config-with-questions.md): Returns the full assessment config including embedded questions array. Returns 404 if the config doesn't exist or doesn't belong to the caller.
- [List assessment configs](https://docs.auditynow.com/api-reference/assessment-configs/list-assessment-configs.md): Returns paginated list of assessment configurations (templates and working configs). Optional `isTemplate` filter to show only templates.
- [Partially update an assessment config](https://docs.auditynow.com/api-reference/assessment-configs/partially-update-an-assessment-config.md): Partially updates an assessment config. All fields optional, but at least one must be present. Validates that the final config has active questions and sufficient scored questions. Returns 400 VALIDATION_ERROR if constraints are violated.
- [Poll async job status](https://docs.auditynow.com/api-reference/jobs/poll-async-job-status.md): Returns the status of an async job. Use to poll the result of `/api/agent/projects/{id}/audit-analysis/async`. Statuses are pending, processing, completed, or failed.
- [Convert a lead into a full audit project](https://docs.auditynow.com/api-reference/leads/convert-a-lead-into-a-full-audit-project.md): Converts a lead into a full audit project. Side effects: creates project, seeds business-analysis, creates a client profile, generates a PDF document, deducts credits, marks lead as `converted`, dispatches Inngest events.
- [Get a single lead with full survey responses](https://docs.auditynow.com/api-reference/leads/get-a-single-lead-with-full-survey-responses.md): Returns a single lead with full survey responses and tracking URL metadata. Response wrapper: `{ lead: LeadDetail }`. Use this after `listLeads` returns a candidate to inspect before deciding whether to convert.
- [List ReadyLink leads](https://docs.auditynow.com/api-reference/leads/list-readylink-leads.md): Returns the user's leads from ReadyLinks, with filters, pagination, and sort. Response is wrapped: `{ data: Lead[], pagination: {...}, filters: {...} }`.
- [Create a Nucleus contact](https://docs.auditynow.com/api-reference/nucleus/create-a-nucleus-contact.md): Creates a contact in Audity's lightweight CRM. Only `name` is required, all other fields are optional. `relationshipType` is silently coerced to `null` if not one of the allowed enum values.
- [Create a Nucleus memory manually](https://docs.auditynow.com/api-reference/nucleus/create-a-nucleus-memory-manually.md): Creates a memory of source type `explicit` (user-asserted fact). The memory is automatically embedded for semantic search.
- [Delete a Nucleus contact](https://docs.auditynow.com/api-reference/nucleus/delete-a-nucleus-contact.md): Hard-deletes a contact. The contact's ID is passed in the JSON body as `contactId` (NOT in the URL path). Returns 404 if no contact with that ID is owned by the caller.
- [Get a single capture and its extracted items](https://docs.auditynow.com/api-reference/nucleus/get-a-single-capture-and-its-extracted-items.md): Returns the full capture record plus the structured items extracted from it (action items, decisions, key insights, contact mentions). Items are produced by an Inngest background job after the capture is created.
- [Get AI-generated prompt suggestions](https://docs.auditynow.com/api-reference/nucleus/get-ai-generated-prompt-suggestions.md): Returns 3 contextual prompt suggestions tailored to the current project (or general workspace if no `projectId`). Useful for agent UIs that want to surface "what could I ask Audity" prompts.
- [List Nucleus captures](https://docs.auditynow.com/api-reference/nucleus/list-nucleus-captures.md): Captures are units of information ingested into Nucleus: text notes, transcripts, voice notes, emails, calendar entries, etc. Each capture is processed by an Inngest background job that extracts structured items (action items, decisions, key insights).
- [List Nucleus contacts](https://docs.auditynow.com/api-reference/nucleus/list-nucleus-contacts.md): Returns the user's contacts (Audity's lightweight CRM). Optional `?search=` performs a case-insensitive partial match against contact name and company.
- [List Nucleus memories](https://docs.auditynow.com/api-reference/nucleus/list-nucleus-memories.md): Returns the user's persistent memories. Three types: - `client`: facts about a specific client/project - `pattern`: cross-client insights the consultant has developed - `preference`: the consultant's working style
- [List proactive AI insights](https://docs.auditynow.com/api-reference/nucleus/list-proactive-ai-insights.md): Returns insights generated by Nucleus's background cron jobs. Insight types include `pre_meeting`, `overdue_followup`, `pattern_detected`, `referral_opportunity`, `portfolio_insight`, `stale_client`, `similar_lead`, `content_suggestion`.
- [Reprocess a capture](https://docs.auditynow.com/api-reference/nucleus/reprocess-a-capture.md): Resets the capture's status to `pending` and dispatches the extraction pipeline again. Use this to retry after a `failed` status or to re-run extraction after a pipeline fix.
- [Soft-delete a capture](https://docs.auditynow.com/api-reference/nucleus/soft-delete-a-capture.md): Marks the capture as archived (`is_archived = true`). The record is preserved on disk for audit purposes; it disappears from `GET /api/nucleus/captures` and detail fetches.
- [Soft-delete a memory](https://docs.auditynow.com/api-reference/nucleus/soft-delete-a-memory.md): Marks the memory as archived (`is_archived = true`). The record is preserved on disk; it disappears from `GET /api/nucleus/memories` and from semantic-search results.
- [Soft-delete a Nucleus memory (body-passed ID)](https://docs.auditynow.com/api-reference/nucleus/soft-delete-a-nucleus-memory-body-passed-id.md): Alternative to `DELETE /api/nucleus/memories/{id}`. Takes the target memory's ID in the JSON body as `memoryId`. Soft-deletes (archives) the memory.
- [Submit a text note as a Nucleus capture](https://docs.auditynow.com/api-reference/nucleus/submit-a-text-note-as-a-nucleus-capture.md): Creates a `text_note` capture from a string. The capture is queued for asynchronous processing by an Inngest job that extracts action items, decisions, and key insights into structured records.
- [Update a Nucleus contact](https://docs.auditynow.com/api-reference/nucleus/update-a-nucleus-contact.md): Partially updates a contact. The contact's ID is passed in the JSON body as `contactId` (NOT in the URL path, this endpoint operates on the collection root).
- [Update an existing Nucleus memory](https://docs.auditynow.com/api-reference/nucleus/update-an-existing-nucleus-memory.md): Updates `subject` and/or `content` on an existing memory. The target memory's ID is passed in the JSON body as `memoryId` (NOT in the URL path, this endpoint operates on the collection root, mirroring the contacts pattern). At least one of `subject` or `content` must be present.
- [Create a new audit project](https://docs.auditynow.com/api-reference/projects/create-a-new-audit-project.md): Creates a new audit project for a client. **Costs 1,000 credits.** Returns the project with status `setup`. After creation, the typical next step is to add source material, either a human uploads documents via the web app, or an MCP-connected agent calls `audity_upload_document`/`audity_create_inter…
- [Fetch the deliverables dashboard for a project](https://docs.auditynow.com/api-reference/projects/fetch-the-deliverables-dashboard-for-a-project.md): Returns the deliverables dashboard for a project. **Response is wrapped: `{ success: true, data: DashboardData }`.** Returns 404 if no audit analysis has been run yet (call `POST .../audit-analysis` first).
- [Get a single project's full detail](https://docs.auditynow.com/api-reference/projects/get-a-single-projects-full-detail.md): Returns the full project record, including documents array and analysis status flags. Returns 404 if the project doesn't exist or doesn't belong to the authenticated user (ownership is enforced by an explicit `user_id` filter in this route, not RLS, since the route uses the service-role client).
- [Get the latest audit analysis](https://docs.auditynow.com/api-reference/projects/get-the-latest-audit-analysis.md): Returns the most recent completed audit analysis for the project. If analysis is still running, returns `status: "running"`. If never run, returns 404.
- [List AI-generated opportunities for a project](https://docs.auditynow.com/api-reference/projects/list-ai-generated-opportunities-for-a-project.md): Returns the AI-generated opportunities Audity identified during audit analysis. Each opportunity includes impact/effort scores (1-10), ROI potential, implementation timeline, and execution metadata. Filter by `?category=` (`quick_wins`, `big_swings`, `nice_to_haves`, `deprioritize`).
- [List the user's audit projects](https://docs.auditynow.com/api-reference/projects/list-the-users-audit-projects.md): Returns all of the user's audit projects, ordered by most recently updated. Each project includes status flags (`hasAnalysis`, `hasInterviewAnalysis`, `hasAuditAnalysis`, `hasDeliverables`), document and stakeholder counts, and a calculated `analysisProgress` percentage. Sorted to surface projects w…
- [Partially update a project](https://docs.auditynow.com/api-reference/projects/partially-update-a-project.md): Updates an allowlisted subset of project fields. At least one allowed field must be present in the body. Project status, ownership, and credits are NOT updatable via this endpoint.
- [Trigger async audit analysis job](https://docs.auditynow.com/api-reference/projects/trigger-async-audit-analysis-job.md): Triggers an asynchronous audit analysis job. Requires that both `business_analysis` (document analysis) and `interview_analysis` records with `is_current=true` already exist for the project. Returns 202 with a job ID for polling. No request body required.
- [Trigger the audit synthesis pipeline](https://docs.auditynow.com/api-reference/projects/trigger-the-audit-synthesis-pipeline.md): Runs Audity's full audit synthesis for the project: downloads documents, extracts text, runs the map-reduce AI synthesis pipeline, saves the resulting `audit_analysis` row, and may queue downstream framework jobs.
- [Create a new ReadyLink](https://docs.auditynow.com/api-reference/readylinks/create-a-new-readylink.md): Creates a new ReadyLink for the user. Requires the `write` scope on PATs. Optional fields include a template to copy from and customization fields (consultant name, company, logo, booking link, description). Returns 402 READYLINK_LIMIT_REACHED if tier quota exceeded.
- [Fetch a single ReadyLink](https://docs.auditynow.com/api-reference/readylinks/fetch-a-single-readylink.md): Returns the ReadyLink by ID if it exists and is active (soft-deleted ones return 404). Returns 404 if the ReadyLink doesn't exist or doesn't belong to the caller.
- [List ReadyLinks](https://docs.auditynow.com/api-reference/readylinks/list-readylinks.md): Returns paginated list of the user's ReadyLinks, with filtering, sorting, and pagination. Feature-gated on the `multiReadyLink` flag. Returns 403 FEATURE_NOT_AVAILABLE if disabled.
- [Partially update a ReadyLink](https://docs.auditynow.com/api-reference/readylinks/partially-update-a-readylink.md): Partially updates a ReadyLink. All fields are optional. When `assessmentConfigId` is provided and is a new UUID, a copy of that template is created for this ReadyLink. Returns 404 if the ReadyLink doesn't exist or doesn't belong to the caller.
- [Soft-delete a ReadyLink](https://docs.auditynow.com/api-reference/readylinks/soft-delete-a-readylink.md): Soft-deletes a ReadyLink by setting `is_active=false`. The record is not removed, just hidden. Returns 204 on success. Returns 404 if the ReadyLink doesn't exist or doesn't belong to the caller.
- [Authentication](https://docs.auditynow.com/authentication.md): How Audity Personal Access Tokens (PATs) work, scopes, rotation, and what gets logged.
- [AI provider](https://docs.auditynow.com/guide/account-billing/ai-provider.md): Choose and configure the default AI model Audity uses for analysis and generation.
- [Cancellation](https://docs.auditynow.com/guide/account-billing/cancellation.md): How to cancel your subscription and what happens to your data and access afterwards.
- [Credits and usage](https://docs.auditynow.com/guide/account-billing/credits-and-usage.md): Understand what credits are, what consumes them, and what happens when you run out.
- [Manage your subscription](https://docs.auditynow.com/guide/account-billing/manage-subscription.md): View and change your plan, reactivate a paused subscription, and understand what happens when your account is deactivated.
- [Plans](https://docs.auditynow.com/guide/account-billing/plans.md): Compare Solo, Team, and Enterprise plans and what each includes.
- [Profile settings](https://docs.auditynow.com/guide/account-billing/profile-settings.md): Manage your personal profile and your firm's profile in Audity.
- [For consulting teams](https://docs.auditynow.com/guide/consulting-teams/overview.md): How the Team and Enterprise plans support multi-seat consulting workflows, white-label delivery, and per-seat billing.
- [Seats and roles](https://docs.auditynow.com/guide/consulting-teams/seats-and-roles.md): Add and remove seats, invite teammates, and manage role-based permissions across your consulting team.
- [Team billing](https://docs.auditynow.com/guide/consulting-teams/team-billing.md): How per-seat billing works for Team plans, including adding and removing seats and how changes affect your invoice.
- [Team dashboard](https://docs.auditynow.com/guide/consulting-teams/team-dashboard.md): How the Audity dashboard changes when multiple teammates are active, shared project visibility, notifications, and team-aware lead behavior.
- [White-label](https://docs.auditynow.com/guide/consulting-teams/white-label.md): Replace Audity's branding with your firm's logo and colors on client-facing surveys and reports.
- [Choose a plan](https://docs.auditynow.com/guide/get-started/choose-a-plan.md): Understand the Solo, Team, and Enterprise plans and how to select one during Audity onboarding.
- [Run your first audit](https://docs.auditynow.com/guide/get-started/first-audit.md): Create your first project in Audity and follow the audit lifecycle from setup to deliverable generation.
- [Welcome to Audity](https://docs.auditynow.com/guide/get-started/introduction.md): Audity helps consulting teams run AI readiness audits, generate leads, and deliver professional reports to clients.
- [Set up your firm profile](https://docs.auditynow.com/guide/get-started/set-up-firm-profile.md): Complete the 5-step business-context wizard to configure your firm's profile in Audity.
- [Sign up and sign in](https://docs.auditynow.com/guide/get-started/sign-up.md): Create your Audity account, sign in, and understand what happens on your first login.
- [Gamma](https://docs.auditynow.com/guide/integrations/gamma.md): Turn your Audity audit deliverables into a polished Gamma presentation in one click.
- [n8n](https://docs.auditynow.com/guide/integrations/n8n.md): Export Audity deliverables to n8n and wire Audity webhook events into automated workflows.
- [Webhooks](https://docs.auditynow.com/guide/integrations/webhooks.md): Receive real-time Audity events at your own HTTPS endpoint.
- [Branded surveys](https://docs.auditynow.com/guide/lead-generation/branded-surveys.md): How the AI Readiness Survey looks and works for your prospects, and how your firm's branding appears throughout.
- [Converting leads](https://docs.auditynow.com/guide/lead-generation/converting-leads.md): Turn a reviewed AI-readiness lead into an audit project with a recommended follow-up workflow.
- [Custom domains](https://docs.auditynow.com/guide/lead-generation/custom-domains.md): Configure a custom domain for your ReadyLinks and branded surveys so prospects see your firm's URL instead of Audity's default domain.
- [Lead generation overview](https://docs.auditynow.com/guide/lead-generation/overview.md): How Audity turns AI-readiness surveys into qualified leads for your consulting firm.
- [ReadyLinks](https://docs.auditynow.com/guide/lead-generation/readylinks.md): Create and share branded survey links to capture AI-readiness leads for your consulting firm.
- [Reviewing leads](https://docs.auditynow.com/guide/lead-generation/reviewing-leads.md): Use the Readiness Inbox to filter, review, and update the status of AI Readiness Survey submissions.
- [Ask Nucleus questions](https://docs.auditynow.com/guide/nucleus/asking-questions.md): Learn how to phrase prompts and what project context Nucleus can see so you get accurate, useful answers during an audit.
- [Memory and context](https://docs.auditynow.com/guide/nucleus/memory-and-context.md): Understand how Nucleus uses project context, what persists across a session, and the limits of its memory.
- [What is Nucleus](https://docs.auditynow.com/guide/nucleus/overview.md): Nucleus is Audity's in-app AI assistant that surfaces context-aware insights while you work on a project.
- [Error codes](https://docs.auditynow.com/guide/reference/error-codes.md): Reference table of Audity error codes, what triggers them, and how to resolve each one.
- [Supported file types](https://docs.auditynow.com/guide/reference/file-types.md): Document formats you can upload for analysis in Audity, and the size limits that apply.
- [Glossary](https://docs.auditynow.com/guide/reference/glossary.md): Definitions of key terms used throughout the Audity platform and documentation.
- [Tier limits](https://docs.auditynow.com/guide/reference/tier-limits.md): A comparison of what each Audity plan includes across seats, projects, credits, analyses, white-label, and integrations.
- [Analysis](https://docs.auditynow.com/guide/run-an-audit/analysis.md): Run the AI synthesis that turns all gathered inputs into structured audit findings.
- [Analysis limits](https://docs.auditynow.com/guide/run-an-audit/analysis-limits.md): Per-analysis limits, timeouts, and credit consumption across the audit lifecycle.
- [Client profile](https://docs.auditynow.com/guide/run-an-audit/client-profile.md): Capture the company profile for the client being audited.
- [Deliverables](https://docs.auditynow.com/guide/run-an-audit/deliverables.md): Export the full deliverables bundle and share audit outputs with clients.
- [Discovery](https://docs.auditynow.com/guide/run-an-audit/discovery.md): Complete the discovery questionnaire to capture structured inputs for the audit.
- [Documents](https://docs.auditynow.com/guide/run-an-audit/documents.md): Upload client documents for AI analysis as part of the audit evidence corpus.
- [Final report](https://docs.auditynow.com/guide/run-an-audit/final-report.md): Compile the consolidated final report from all audit outputs.
- [Frameworks](https://docs.auditynow.com/guide/run-an-audit/frameworks.md): Apply AI-readiness frameworks to score and contextualise the audit findings.
- [Interviews](https://docs.auditynow.com/guide/run-an-audit/interviews.md): Capture and analyse stakeholder interviews to add qualitative depth to your audit.
- [Stakeholder memos](https://docs.auditynow.com/guide/run-an-audit/memos.md): Auto-generate tailored memos for each stakeholder group based on audit findings.
- [Opportunity matrix](https://docs.auditynow.com/guide/run-an-audit/opportunity-matrix.md): Review and refine the visual prioritisation grid of audit opportunities.
- [Run an Audit: overview](https://docs.auditynow.com/guide/run-an-audit/overview.md): The end-to-end 13-step lifecycle for running an AI readiness audit in Audity.
- [Project dashboard](https://docs.auditynow.com/guide/run-an-audit/project-dashboard.md): Navigate the project dashboard and understand your position in the audit lifecycle.
- [Project setup](https://docs.auditynow.com/guide/run-an-audit/project-setup.md): Create a new audit project and configure its basic settings.
- [ROI calculations](https://docs.auditynow.com/guide/run-an-audit/roi.md): Generate ROI projections tied to the audit's identified opportunities.
- [Web intelligence](https://docs.auditynow.com/guide/run-an-audit/web-intelligence.md): Run automated web research to gather public intelligence about the client before the audit begins.
- [Guided Audit Conductor](https://docs.auditynow.com/guides/audit-conductor.md): Orchestrate the full audit pipeline with automatic step progression, cost previews, and long-job polling.
- [Connect ChatGPT](https://docs.auditynow.com/guides/chatgpt.md): Use Audity from ChatGPT via a Custom GPT with MCP (manual setup).
- [Connect Claude](https://docs.auditynow.com/guides/claude.md): Use Claude Desktop or claude.ai with Audity via npx @auditynow/connect (auto-configures) or manual MCP setup.
- [Claude Code](https://docs.auditynow.com/guides/claude-code.md): Connect Audity to Claude Code via MCP (auto-configured by npx @auditynow/connect) or call the REST API directly.
- [Connect with One Command](https://docs.auditynow.com/guides/connect-cli.md): Use npx @auditynow/connect to automatically set up the Audity MCP server in Claude Desktop, Claude Code, and Cursor.
- [Connect Cursor](https://docs.auditynow.com/guides/cursor.md): Use Audity inside Cursor via MCP (auto-configured by npx @auditynow/connect) or manual setup.
- [Lead Conversion Playbook](https://docs.auditynow.com/guides/lead-conversion.md): Triage ReadyLink leads and convert the best ones into full audits, from your AI assistant.
- [Connect n8n](https://docs.auditynow.com/guides/n8n.md): Use Audity inside n8n via the MCP Client Tool node, or call endpoints from HTTP Request nodes.
- [Running an Audit End-to-End](https://docs.auditynow.com/guides/running-an-audit.md): The full agent recipe for taking a client from intake to deliverables, in one prompt.
- [Working with Nucleus](https://docs.auditynow.com/guides/working-with-nucleus.md): Search memories, capture notes, surface insights, from outside the app.
- [Audity for Agents](https://docs.auditynow.com/introduction.md): Drive your Audity workspace from any HTTP client, automation tool, or AI assistant.
- [Quickstart](https://docs.auditynow.com/quickstart.md): Get an AI agent talking to your Audity workspace in one command.

## OpenAPI Specs

- [openapi](https://docs.auditynow.com/api-reference/openapi.json)