> ## 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.

# Analyze Brief

> Analyze a project brief and extract requirements using AI.

**Required scope:** `read`

Send a text description of a project and get back structured requirements
with complexity and priority estimates.



## OpenAPI

````yaml /openapi/openapi-external.json post /ai/analyze-brief
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/analyze-brief:
    post:
      tags:
        - AI Services
      summary: Analyze Brief
      description: >-
        Analyze a project brief and extract requirements using AI.


        **Required scope:** `read`


        Send a text description of a project and get back structured
        requirements

        with complexity and priority estimates.
      operationId: analyze_brief_api_external_v1_ai_analyze_brief_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BriefAnalysisRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BriefAnalysisResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyHeader: []
components:
  schemas:
    BriefAnalysisRequest:
      properties:
        brief:
          type: string
          maxLength: 50000
          minLength: 10
          title: Brief
        language:
          type: string
          enum:
            - es
            - en
          title: Language
          default: en
        uiLanguage:
          anyOf:
            - type: string
              enum:
                - es
                - en
            - type: 'null'
          title: Uilanguage
        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
        existingRequirements:
          anyOf:
            - items:
                $ref: '#/components/schemas/ExistingRequirement'
              type: array
            - type: 'null'
          title: Existingrequirements
      type: object
      required:
        - brief
      title: BriefAnalysisRequest
      description: Schema for brief analysis request.
    BriefAnalysisResponse:
      properties:
        requirements:
          items:
            $ref: '#/components/schemas/RequirementResponse'
          type: array
          title: Requirements
        success:
          type: boolean
          title: Success
          default: true
        error:
          anyOf:
            - type: string
            - type: 'null'
          title: Error
      type: object
      required:
        - requirements
      title: BriefAnalysisResponse
      description: Schema for brief analysis response.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ExistingRequirement:
      properties:
        id:
          anyOf:
            - type: string
            - type: 'null'
          title: Id
        name:
          type: string
          title: Name
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
          default: ''
        rationale:
          anyOf:
            - type: string
            - type: 'null'
          title: Rationale
          default: ''
        complexity:
          type: integer
          title: Complexity
          default: 3
        priority:
          type: string
          title: Priority
          default: medium
        manuallyEdited:
          type: boolean
          title: Manuallyedited
          default: false
      type: object
      required:
        - name
      title: ExistingRequirement
      description: Schema for existing requirement context.
    RequirementResponse:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        description:
          type: string
          title: Description
          default: ''
        rationale:
          type: string
          title: Rationale
          default: ''
        complexity:
          type: integer
          enum:
            - 1
            - 3
            - 5
            - 8
          title: Complexity
        priority:
          type: string
          enum:
            - high
            - medium
            - low
          title: Priority
        nameUi:
          anyOf:
            - type: string
            - type: 'null'
          title: Nameui
        descriptionUi:
          anyOf:
            - type: string
            - type: 'null'
          title: Descriptionui
      type: object
      required:
        - id
        - name
        - complexity
        - priority
      title: RequirementResponse
      description: Schema for a generated requirement.
    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

````