> ## 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 assessment config template > 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. ## OpenAPI ````yaml /api-reference/openapi.json post /api/agent/assessment-configs 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/agent/assessment-configs: post: tags: - Assessment Configs summary: Create a new assessment config template description: >- 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. operationId: createAssessmentConfig requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateAssessmentConfigInput' example: name: Manufacturing Readiness Template questionOrder: - q1 - q2 - q5 - q10 responses: '201': description: Template created content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/AssessmentConfig' required: - data '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': description: Template quota exceeded for this tier. content: application/json: schema: $ref: '#/components/schemas/ErrorWithCode' example: error: Template limit reached code: QUOTA_EXCEEDED '403': description: Insufficient scope (PAT missing write). content: application/json: schema: $ref: '#/components/schemas/ErrorWithCode' '429': $ref: '#/components/responses/RateLimited' security: - bearerAuth: [] components: schemas: CreateAssessmentConfigInput: type: object properties: name: type: string minLength: 1 maxLength: 100 description: Name for this template. questionOrder: type: - array - 'null' items: type: string pattern: >- ^(q\d+|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ description: >- Optional list of question IDs in desired order. Each entry must be a default question ID (e.g., q1, q2, q25) or a UUID. Defaults to full range if omitted. required: - name AssessmentConfig: type: object description: >- An assessment configuration defining which questions are asked and how they are scored. properties: id: type: string format: uuid name: type: - string - 'null' description: Human-readable name for this configuration. isTemplate: type: boolean description: >- If true, this is a reusable template. If false, it's a working config tied to a ReadyLink. questionOrder: type: array items: type: string description: >- Ordered list of question IDs (e.g., q1, q2, q5). Determines survey order. hiddenQuestions: type: array items: type: string description: Question IDs explicitly hidden from the survey. scoringWeights: type: object additionalProperties: type: number description: Mapping of question ID to numeric weight for scoring. defaultQuestionOverrides: type: object additionalProperties: true description: Per-question customizations (e.g., answer options, min/max). questionCount: type: integer description: Count of active (non-hidden) questions. createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - id - isTemplate - questionOrder - questionCount - createdAt - updatedAt ErrorWithCode: type: object description: >- Error response with an optional stable `code` field. When present, branch on `code` (the human-readable `error` may change). Some 403/400 responses omit `code` (e.g. generic feature-disabled gates). properties: error: type: string description: Human-readable error message. code: type: string description: >- Stable error code, when applicable. Examples: `EMPTY_PATCH`, `INVALID_DESCRIPTION_TYPE`, `DESCRIPTION_TOO_LONG`, `PAT_MALFORMED`, `PAT_ROUTE_NOT_ALLOWED`, `PAT_NOT_SUPPORTED_FOR_ENDPOINT`, `PAT_SCOPE_INSUFFICIENT`, `PAT_DISABLED`. required: - error Error: type: object properties: error: type: string description: Human-readable error message. details: type: string description: Additional context (development only). 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 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>`. ````