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

# Start Analysis

> Initiates a background analysis task for a repository



## OpenAPI

````yaml /openapi.json post /api/analysis/start
openapi: 3.0.3
info:
  title: CodeAnt AI API
  description: >-
    API for code analysis (SAST, SCA, secrets, IaC) and developer productivity
    metrics. Supports GitHub, GitLab, Bitbucket, and Azure DevOps.
  version: 1.0.0
servers:
  - url: https://api.codeant.ai
    description: Production server
security: []
tags:
  - name: Analysis
    description: Code analysis operations
  - name: Agent Analysis
    description: >-
      AI-powered agent analysis operations. Uses LLM-based code exploration
      agents to perform deep security threat hunting, bug finding, and custom
      analysis with reflection-based false positive filtering.
  - name: Developer Metrics — Teams
    description: >-
      Manage developer teams: create, update, delete teams and manage team
      membership. Teams are used to organize developers and scope metrics.
  - name: Developer Metrics
    description: >-
      Developer productivity and activity metrics: active developers, PR
      throughput, individual comparisons, and AI-generated summaries. All
      endpoints support GitHub, GitLab, Bitbucket, and Azure DevOps.
paths:
  /api/analysis/start:
    post:
      tags:
        - Analysis
      summary: Start Analysis
      description: Initiates a background analysis task for a repository
      operationId: startAnalysis
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AnalysisStartRequest'
            examples:
              github:
                summary: GitHub repository example
                value:
                  repo: owner/repository
                  commit_id: abc123def456
                  access_token: ghp_xxxxxxxxxxxx
                  service: github
                  branch: main
                  include_files: src/**/*.py,lib/**/*.js,app/**/*.ts
                  exclude_files: tests/**,node_modules/**,dist/**
              azuredevops:
                summary: Azure DevOps repository example
                value:
                  repo: organization/project/repository
                  commit_id: abc123def456
                  access_token: pat_xxxxxxxxxxxx
                  service: azuredevops
                  branch: main
                  include_files: src/**/*.cs,src/**/*.js
                  exclude_files: tests/**,bin/**,obj/**
      responses:
        '200':
          description: Analysis successfully started
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
              example:
                message: Analysis started
        '401':
          description: Invalid access token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Access token invalid
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Error running analysis
components:
  schemas:
    AnalysisStartRequest:
      type: object
      required:
        - repo
        - commit_id
        - access_token
        - service
      properties:
        repo:
          type: string
          description: Repository identifier (format varies by service)
          example: owner/repository
        commit_id:
          type: string
          description: Git commit SHA or identifier
          example: abc123def456
        access_token:
          type: string
          description: Authentication token for the service
          example: ghp_xxxxxxxxxxxx
        service:
          type: string
          description: Version control service provider
          enum:
            - github
            - azuredevops
            - gitlab
            - bitbucket
          example: github
        branch:
          type: string
          description: Git branch name
          example: main
        include_files:
          type: string
          description: Comma-separated file patterns to include in analysis
          example: src/**/*.py,lib/**/*.js,app/**/*.ts
        exclude_files:
          type: string
          description: Comma-separated file patterns to exclude from analysis
          example: tests/**,node_modules/**,dist/**
    SuccessResponse:
      type: object
      properties:
        message:
          type: string
          description: Success message
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Error message

````