> ## 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. # Trigger the audit synthesis pipeline > 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. **This is a synchronous, long-running call.** Typical duration: 60–300 seconds depending on document volume. The HTTP request will block until completion. For projects that already have current document and interview analyses, short-timeout clients can use `POST /api/agent/projects/{id}/audit-analysis/async` and poll `GET /api/agent/jobs/{jobId}`. **Cost:** consumes AI compute credits (separate from the 1,000-credit project creation cost). **Plan required:** an audit-capable write plan. ## OpenAPI ````yaml /api-reference/openapi.json post /api/projects/{id}/audit-analysis openapi: 3.1.0 info: title: Audity Agent API version: 1.0.0 summary: >- The agent-facing surface of Audity AI: projects, leads, Nucleus, and account. description: >- Audity is a B2B SaaS for consultants who run automated business audits. This API is the agent-facing slice: a deliberately small set of task-shaped endpoints that lets external AI agents (Claude, ChatGPT, Cursor, n8n) act on a consultant's Audity workspace on their behalf. **Authentication:** Bearer token (`aky_...`) issued from `https://app.auditynow.com/dashboard/settings/api-tokens`. The middleware resolves the token to a Clerk user identity; tier and Row-Level Security gates apply automatically. **Rate limits:** reads 100/min, writes 20/min, async job polling 120/min; some expensive or high-volume endpoints have stricter caps. 429 responses include `Retry-After`. **Tier gating:** public plan names can change faster than API enum names. Use `GET /api/user/tier` and any `requiredTier` field in 403 responses as the source of truth for a specific account. Read-only or lead-generation-focused plans can read available data; audit-capable paid plans unlock writes, subject to token scope and credits. contact: name: Audity Support email: support@auditynow.com url: https://app.auditynow.com license: name: Proprietary identifier: LicenseRef-Audity-Proprietary termsOfService: https://auditynow.com/terms servers: - url: https://app.auditynow.com description: Production security: - bearerAuth: [] tags: - name: Projects description: >- Audit project lifecycle, create, list, fetch, trigger analysis, get deliverables. - name: Leads description: ReadyLink-sourced leads, list, fetch, convert into projects. - name: Nucleus description: >- Nucleus is Audity's persistent memory + insight layer. Search memories, capture notes, read proactive insights, manage contacts. - name: Account description: Identity, tier, credits, usually called once per session for context. - name: ReadyLinks description: >- Manage ReadyLinks, the survey distribution links that generate leads. CRUD operations for links, customization, lead tracking. - name: Assessment Configs description: >- Manage assessment configurations that define survey questions, order, scoring, and customization. - name: Jobs description: >- Monitor async job status for long-running operations like audit analysis synthesis. paths: /api/projects/{id}/audit-analysis: parameters: - $ref: '#/components/parameters/ProjectId' post: tags: - Projects summary: Trigger the audit synthesis pipeline description: >- 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. **This is a synchronous, long-running call.** Typical duration: 60–300 seconds depending on document volume. The HTTP request will block until completion. For projects that already have current document and interview analyses, short-timeout clients can use `POST /api/agent/projects/{id}/audit-analysis/async` and poll `GET /api/agent/jobs/{jobId}`. **Cost:** consumes AI compute credits (separate from the 1,000-credit project creation cost). **Plan required:** an audit-capable write plan. operationId: triggerAuditAnalysis responses: '200': description: >- Audit synthesis complete. Body includes the saved analysis record and request metadata. content: application/json: schema: $ref: '#/components/schemas/AuditAnalysisRunResult' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/InsufficientCreditsOrTier' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/RateLimited' '500': $ref: '#/components/responses/ServerError' components: parameters: ProjectId: name: id in: path required: true description: The project's UUID. schema: type: string format: uuid schemas: AuditAnalysisRunResult: type: object properties: analysis: $ref: '#/components/schemas/AuditAnalysisResult' requestData: type: object description: Echo of the synthesis input parameters used. message: type: string required: - analysis AuditAnalysisResult: type: object properties: id: type: string format: uuid projectId: type: string format: uuid status: type: string enum: - running - complete - failed createdAt: type: string format: date-time executiveSummary: type: - string - 'null' opportunityCount: type: integer riskCount: type: integer synthesis: type: object description: >- Full structured synthesis output. Shape varies by audit type. See Audity-v1/types/comprehensive-audit.ts for full type. required: - id - projectId - status Error: type: object properties: error: type: string description: Human-readable error message. details: type: string description: Additional context (development only). required: - error TierError: type: object properties: error: type: string currentTier: type: string enum: - solo - starter - growth - agency requiredTier: type: string enum: - solo - starter - growth - agency upgradeUrl: type: string format: uri required: - error responses: Unauthorized: description: Missing or invalid token. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: Unauthorized InsufficientCreditsOrTier: description: Either you're out of credits or your tier doesn't include this feature. content: application/json: schema: $ref: '#/components/schemas/TierError' example: error: Feature not available on your tier currentTier: solo requiredTier: starter upgradeUrl: https://app.auditynow.com/billing/upgrade NotFound: description: Resource not found, or you don't have access (RLS). content: application/json: schema: $ref: '#/components/schemas/Error' RateLimited: description: Rate limit exceeded. headers: Retry-After: schema: type: integer description: Seconds to wait before retrying. content: application/json: schema: $ref: '#/components/schemas/Error' ServerError: description: Internal server error. content: application/json: schema: $ref: '#/components/schemas/Error' securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: Audity Personal Access Token (aky_...) description: >- A Personal Access Token issued from https://app.auditynow.com/dashboard/settings/api-tokens. Format: `aky_<32 random chars>`. ````