> ## 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. # Create a new audit project > 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. The async audit endpoint is available for projects that already have current document and interview analyses. **Plan required:** an audit-capable write plan. If the caller's plan cannot create projects, the API returns 403 with tier details. ## OpenAPI ````yaml /api-reference/openapi.json post /api/projects 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: post: tags: - Projects summary: Create a new audit project description: >- 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. The async audit endpoint is available for projects that already have current document and interview analyses. **Plan required:** an audit-capable write plan. If the caller's plan cannot create projects, the API returns 403 with tier details. operationId: createProject requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateProjectInput' example: clientName: Acme Corp industry: Manufacturing companySize: 200-500 description: Mid-market manufacturer evaluating AI transformation readiness. currency: USD responses: '201': description: Project created content: application/json: schema: $ref: '#/components/schemas/Project' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/InsufficientCreditsOrTier' '429': $ref: '#/components/responses/RateLimited' components: schemas: CreateProjectInput: type: object properties: clientName: type: string minLength: 1 maxLength: 200 industry: type: string minLength: 1 maxLength: 100 description: Free-text industry (e.g. 'Manufacturing', 'Healthcare', 'SaaS'). companySize: type: string description: Free-text size band (e.g. '1-10', '50-200', '200-500', '1000+'). maxLength: 50 description: type: - string - 'null' maxLength: 2000 currency: type: string default: USD description: ISO 4217 currency code for monetary values in deliverables. minLength: 3 maxLength: 3 required: - clientName - industry - companySize Project: type: object properties: id: type: string format: uuid clientName: type: string industry: type: string companySize: type: string description: type: - string - 'null' currency: type: string status: $ref: '#/components/schemas/ProjectStatus' createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - id - clientName - industry - companySize - status - createdAt ProjectStatus: type: string enum: - setup - analysis - interviews - complete - archived description: Lifecycle state of an audit project. 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: BadRequest: description: Validation failed. content: application/json: schema: $ref: '#/components/schemas/Error' 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 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' 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>`. ````