> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getquikly.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Generate Discovery Checklist

> Generate a tailored discovery checklist for a project type.

**Required scope:** `read`

Input: projectType, optional industry, context, language.
Output: questions (with priority, category, exampleAnswer), projectSummary, tips.

Use this when you need targeted questions to ask the client before creating a proposal.



## OpenAPI

````yaml /openapi/openapi-external.json post /ai/generate-discovery-checklist
openapi: 3.1.0
info:
  title: Quikly.ai External API
  version: 1.0.0
  description: >-
    REST API for external integrations with Quikly.ai. Authenticate using an API
    key passed in the X-API-Key header. Use these endpoints from n8n, Zapier,
    custom scripts, or any HTTP client.
servers: []
security:
  - ApiKeyAuth: []
tags:
  - name: Proposals
    description: Create, read, update, and manage client proposals.
  - name: Profile
    description: Read and update the authenticated user's profile.
  - name: Templates
    description: Manage reusable proposal templates.
  - name: AI Services
    description: >-
      AI-powered analysis: rate recommendations, brief analysis,
      differentiators.
  - name: Public API
  - name: Usage
    description: Query API usage and quota information.
  - name: Webhooks
    description: Manage webhook subscriptions for real-time events.
  - name: Agent
    description: Interact with the AI agent for automated workflows.
  - name: Lead Sessions
    description: Track and manage lead capture sessions.
paths:
  /ai/generate-discovery-checklist:
    post:
      tags:
        - AI Services
      summary: Generate Discovery Checklist
      description: >-
        Generate a tailored discovery checklist for a project type.


        **Required scope:** `read`


        Input: projectType, optional industry, context, language.

        Output: questions (with priority, category, exampleAnswer),
        projectSummary, tips.


        Use this when you need targeted questions to ask the client before
        creating a proposal.
      operationId: >-
        generate_discovery_checklist_api_external_v1_ai_generate_discovery_checklist_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DiscoveryChecklistRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DiscoveryChecklistResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyHeader: []
components:
  schemas:
    DiscoveryChecklistRequest:
      properties:
        projectType:
          type: string
          maxLength: 100
          minLength: 2
          title: Projecttype
        industry:
          anyOf:
            - type: string
              maxLength: 100
            - type: 'null'
          title: Industry
        context:
          anyOf:
            - type: string
              maxLength: 2000
            - type: 'null'
          title: Context
        language:
          type: string
          enum:
            - es
            - en
          title: Language
          default: en
        apiKey:
          anyOf:
            - type: string
            - type: 'null'
          title: Apikey
        aiProvider:
          anyOf:
            - type: string
              enum:
                - gemini
                - openai
                - anthropic
            - type: 'null'
          title: Aiprovider
          default: gemini
        openaiApiKey:
          anyOf:
            - type: string
            - type: 'null'
          title: Openaiapikey
        anthropicApiKey:
          anyOf:
            - type: string
            - type: 'null'
          title: Anthropicapikey
      type: object
      required:
        - projectType
      title: DiscoveryChecklistRequest
      description: Request to generate a discovery checklist for a project type.
    DiscoveryChecklistResponse:
      properties:
        questions:
          items:
            $ref: '#/components/schemas/DiscoveryQuestion'
          type: array
          title: Questions
          default: []
        projectSummary:
          type: string
          title: Projectsummary
          default: ''
        tips:
          items:
            type: string
          type: array
          title: Tips
          default: []
        success:
          type: boolean
          title: Success
          default: true
        error:
          anyOf:
            - type: string
            - type: 'null'
          title: Error
      type: object
      title: DiscoveryChecklistResponse
      description: Response with a discovery checklist.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    DiscoveryQuestion:
      properties:
        id:
          type: string
          title: Id
        question:
          type: string
          title: Question
        reason:
          type: string
          title: Reason
        category:
          type: string
          title: Category
        priority:
          type: string
          enum:
            - high
            - medium
            - low
          title: Priority
        exampleAnswer:
          type: string
          title: Exampleanswer
      type: object
      required:
        - id
        - question
        - reason
        - category
        - priority
        - exampleAnswer
      title: DiscoveryQuestion
      description: A single discovery question.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key obtained from Quikly.ai Settings → API Keys.
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key

````