> ## 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 ReadyLink > 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. ## OpenAPI ````yaml /api-reference/openapi.json post /api/agent/readylinks 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/readylinks: post: tags: - ReadyLinks summary: Create a new ReadyLink description: >- 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. operationId: createReadyLink requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateReadyLinkInput' example: name: Q2 2026 Lead Gen consultantName: Jane Consultant consultantCompany: JAC Consulting bookingLink: https://calendly.com/jane responses: '201': description: ReadyLink created content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/ReadyLink' required: - data '400': description: >- Validation failed. Invalid name length or assessmentConfigId not found. content: application/json: schema: $ref: '#/components/schemas/ErrorWithCode' example: error: Assessment config not found or not accessible code: INVALID_REQUEST_BODY '401': $ref: '#/components/responses/Unauthorized' '402': description: ReadyLink quota reached for this tier. content: application/json: schema: $ref: '#/components/schemas/ErrorWithCode' example: error: ReadyLink limit reached for tier code: READYLINK_LIMIT_REACHED '403': description: Feature flag disabled or insufficient scope (PAT missing write). content: application/json: schema: $ref: '#/components/schemas/ErrorWithCode' '429': $ref: '#/components/responses/RateLimited' security: - bearerAuth: [] components: schemas: CreateReadyLinkInput: type: object properties: name: type: string minLength: 1 maxLength: 100 description: Name for this ReadyLink. assessmentConfigId: type: - string - 'null' format: uuid description: Optional UUID of an existing assessment config template to copy. bookingLink: type: - string - 'null' format: uri description: Optional booking/scheduling link. consultantName: type: - string - 'null' minLength: 1 maxLength: 100 description: Optional customized consultant name. consultantCompany: type: - string - 'null' minLength: 1 maxLength: 100 description: Optional customized company name. consultantLogo: type: - string - 'null' format: uri maxLength: 500 description: Optional logo URL. customDescription: type: - string - 'null' maxLength: 500 description: Optional custom description. required: - name ReadyLink: type: object description: >- A ReadyLink survey distribution link with customization and lead tracking. properties: id: type: string format: uuid slug: type: string description: URL-safe slug for the public survey link. name: type: string description: User-supplied name for this ReadyLink. fullUrl: type: string format: uri description: The complete public survey URL. isActive: type: boolean description: Whether the link is active (false means soft-deleted). assessmentConfigId: type: - string - 'null' format: uuid description: >- UUID of the assessment config (template or working config) used by this link. assessmentConfigName: type: - string - 'null' description: Name of the assessment config, for display purposes. bookingLink: type: - string - 'null' format: uri description: Optional booking/scheduling link to share with respondents. consultantName: type: - string - 'null' description: Customized consultant name displayed on the survey. consultantCompany: type: - string - 'null' description: Customized company name displayed on the survey. consultantLogo: type: - string - 'null' format: uri description: URL of the consultant's logo image. customDescription: type: - string - 'null' description: Custom description or tagline shown on the survey. leadCount: type: integer description: Number of leads generated from this ReadyLink. domainStatus: type: string enum: - not_configured - pending_dns - dns_verified - ssl_pending - active - error description: Status of custom domain configuration, if any. customDomain: type: - string - 'null' description: Custom domain assigned to this ReadyLink, if any. createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - id - slug - name - fullUrl - isActive - leadCount - domainStatus - 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: 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>`. ````