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

# Update insight context

> Saves your edits to the context of a task type. Only fields of the task type (and fields already in the context) are kept. `autoGenerateFrequency` turns scheduled reports on: `weekly` or `monthly`, or `none` to stop them.
Requires the `edit/ai-insight` permission.



## OpenAPI

````yaml /openapi/public/openapi-analytics.json put /ai-insight/context/{objectId}
openapi: 3.0.0
info:
  title: API - Analytics
  version: 3.0.0
  description: API Documentation - RESTful API for field operations management.
servers:
  - url: https://apiweb.mile.app/api/v3
security:
  - bearerAuth: []
tags:
  - name: Dashboard
    description: >-
      Dashboard lets a user compose their own dashboard from any number of
      cards, start from a template, duplicate a dashboard, share it with roles,
      and save it back as an organization template. Each card owns its own
      widget row (a chart type plus a query spec), cloned from the widget
      catalogue (built-in widgets plus the organization's custom widgets), so
      renaming or editing a card never touches the catalogue or another
      dashboard. Dashboards are owned by their creator: roles they are shared
      with can view, duplicate and save as template, but only the owner can edit
      or delete. Every write reuses the dashboard permission family (view, add,
      edit and delete dashboard).


      The numbers behind each card come from one generic aggregation endpoint
      instead of one endpoint per chart: the client sends a batch of up to 12
      declarative query specs, the server injects the caller's organization, hub
      and soft-delete scope from the session, runs each spec read-only, and
      returns a flat columns and rows table per item. The catalog endpoints
      describe the data sources, fields and limits a client may use.
  - name: Report
    description: >-
      A report is a saved table definition over tasks of one task type or
      records of one data type: which fields to show, which hubs to include, and
      the default filters.
  - name: Insight Report
    description: >-
      Insight reports are written summaries of your operations, generated from
      your task and data records: findings, a summary and suggested actions. You
      set the context once per task type, then generate reports on demand or on
      a schedule.
paths:
  /ai-insight/context/{objectId}:
    put:
      tags:
        - Insight Report
      summary: Update insight context
      description: >-
        Saves your edits to the context of a task type. Only fields of the task
        type (and fields already in the context) are kept.
        `autoGenerateFrequency` turns scheduled reports on: `weekly` or
        `monthly`, or `none` to stop them.

        Requires the `edit/ai-insight` permission.
      operationId: updateInsightContext
      parameters:
        - name: objectId
          in: path
          required: true
          description: |-
            Task type (flow) id.
            **Example:** `64ee1a2b3c4d5e6f7a8b9c0d`
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InsightContextRequest'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  status: true
                  data:
                    updatedTime: '2026-10-16T02:00:00.000000Z'
                    updatedBy: ops@example.com
                additionalProperties: true
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    description: Shows if the request was successful.
                  message:
                    type: string
                    description: A short message explaining what went wrong.
                example:
                  status: false
                  message: Bad request - invalid parameters provided.
      deprecated: false
      security:
        - bearerAuth: []
components:
  schemas:
    InsightContextRequest:
      type: object
      properties:
        objectDescription:
          type: string
          description: |-
            What the task type is used for.
            **Example:** `Last-mile delivery of parcels to customer addresses.`
        fieldList:
          type: array
          description: Description per field. Each entry needs `key`.
          items:
            type: object
            required:
              - key
            properties:
              key:
                type: string
                description: |-
                  Field key of the task type.
                  **Example:** `recipientName`
              description:
                type: string
        autoGenerateFrequency:
          type: string
          enum:
            - none
            - weekly
            - monthly
          description: Scheduled report frequency.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Use a valid Bearer token to authenticate.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.