# 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. Tiers: `solo` (read-only API), `starter`, `growth` (adds web research), `agency` (adds bulk + custom domains).
- [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.
- [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 upload documents via the web app, then trigger `POST /api/projects/{id}/audit-analysis` to run the synthesis pipeline.
- [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 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.
- [Authentication](https://docs.auditynow.com/authentication.md): How Audity Personal Access Tokens (PATs) work, scopes, rotation, and what gets logged.
- [Connect ChatGPT](https://docs.auditynow.com/guides/chatgpt.md): Use Audity from ChatGPT via a Custom GPT with Actions.
- [Connect Claude](https://docs.auditynow.com/guides/claude.md): Add Audity as a remote MCP connector inside Claude Desktop, claude.ai, or Claude Code.
- [Connect Cursor](https://docs.auditynow.com/guides/cursor.md): Use Audity inside Cursor via MCP.
- [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 Claude, ChatGPT, Cursor, n8n, or any MCP-compatible AI assistant.
- [Quickstart](https://docs.auditynow.com/quickstart.md): Get an AI agent talking to your Audity workspace in five minutes.

## OpenAPI Specs

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