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

# Generate Report Endpoint

> Generate a .docx insights report.

The report is built by a deterministic python-docx template (no LLM,
no agent) so every call for the same insights produces the same
document shape. Response shape mirrors ``POST /v1/word/generate`` —
callers can reuse their download / edit-URL handling. For a PDF
rendition, follow up with ``POST /v1/runs/{run_id}/export``.



## OpenAPI

````yaml /openapi.json post /projects/{project_id}/reports
openapi: 3.1.0
info:
  title: Overten API
  version: 1.0.0
  description: >-
    Generate and edit Word, Excel, and PowerPoint documents programmatically.
    Powered by the same agents as the Overten web app.
  contact:
    name: Overten Support
    url: https://overten.ai/support
    email: support@overten.ai
  license:
    name: Terms of Service
    url: https://overten.ai/terms
servers:
  - url: https://backend.overtenai.com/api/v1
    description: Production
  - url: http://localhost:8000/api/v1
    description: Local development
security:
  - ApiKeyAuth: []
paths:
  /projects/{project_id}/reports:
    post:
      tags:
        - public
        - projects
      summary: Generate Report Endpoint
      description: |-
        Generate a .docx insights report.

        The report is built by a deterministic python-docx template (no LLM,
        no agent) so every call for the same insights produces the same
        document shape. Response shape mirrors ``POST /v1/word/generate`` —
        callers can reuse their download / edit-URL handling. For a PDF
        rendition, follow up with ``POST /v1/runs/{run_id}/export``.
      operationId: generate_report_endpoint_api_v1_projects__project_id__reports_post
      parameters:
        - name: project_id
          in: path
          required: true
          schema:
            type: string
            title: Project Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReportGenerateRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    ReportGenerateRequest:
      properties:
        format:
          type: string
          const: docx
          title: Format
          default: docx
        title:
          anyOf:
            - type: string
              maxLength: 200
            - type: 'null'
          title: Title
          description: >-
            Optional report title. Defaults to '<project name> — Insights
            Report'.
        include_severity:
          anyOf:
            - items:
                type: string
                enum:
                  - critical
                  - high
                  - medium
                  - low
              type: array
            - type: 'null'
          title: Include Severity
          description: Only include insights with these severities. Omit for all.
        include_alert_kind:
          anyOf:
            - items:
                type: string
                enum:
                  - disparity
                  - insight
                  - similarity
              type: array
            - type: 'null'
          title: Include Alert Kind
          description: Only include insights of these kinds. Omit for all.
        include_resolved:
          type: boolean
          title: Include Resolved
          description: Whether to include resolved insights. Default false.
          default: false
        file_ids:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: File Ids
          description: Restrict to insights whose source.fileId is in this list.
        async:
          type: boolean
          title: Async
          description: Run the report generator in the background and return 202.
          default: false
        webhook_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Webhook Url
      type: object
      title: ReportGenerateRequest
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Send `X-API-Key: sk_live_<your_key>`. Keys are issued via POST /signup
        or via the dashboard. Legacy callers may also use `Authorization: Bearer
        sk_live_<your_key>`.

````