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

# Ask an AI about a record's history

> Sends the complete (unpaginated) activity history for a sales order,
fulfillment order, or shipment to an LLM along with a free-text question,
and returns the model's answer.

Useful for summarising what has happened to a record, diagnosing why an
order behaved a certain way, or generating narrative explanations from
raw audit-trail entries without having to paginate and parse them yourself.

The endpoint loads the full history server-side, so it does not respect
the `page` / `limit` filters of the list endpoint — every entry for the
subject is included in the prompt.




## OpenAPI

````yaml /api-reference/build.yaml post /activity-logs/ask-ai
openapi: 3.0.0
info:
  title: Luminous API
  version: 1.0.0
  description: API documentation for Luminous
servers:
  - url: https://{companyName}.api.joinluminous.com/external/api/v1
    variables:
      companyName:
        default: companyName
        description: Your company-specific subdomain
security: []
tags:
  - name: Products
    description: Get and manage products
  - name: Pricing
    description: Manage price schedules, levels, and customizations
  - name: BOMs
    description: Manage Bills of Materials (BOMs)
  - name: Labels
    description: Label rendering via Labelary ZPL service
  - name: Companies
    description: Manage business accounts and their associated data
  - name: Contacts
    description: Manage contact information for individuals
  - name: Suppliers
    description: Manage suppliers (factories) — vendors used on purchase orders
  - name: Supplier SKUs
    description: Manage per-supplier SKU and unit-cost overrides for products
  - name: Locations
    description: Manage warehouses and locations
  - name: Inventory
    description: Get and adjust product stock levels
  - name: Lots
    description: Create, update, and delete product lots (batches)
  - name: Transfer Orders
    description: Manage transfer orders
  - name: Fulfillment Orders
    description: Manage fulfillment orders and picklists
  - name: Purchase Orders
    description: Get and modify purchase orders
  - name: Receiving Reports
    description: Manage receiving reports
  - name: Payment Obligations
    description: Manage payment obligations for purchase orders
  - name: Sales Orders
    description: Manage sales orders and sales order shipments
  - name: Purgatory
    description: >-
      Inspect and resolve non-posted sales orders in the purgatory staging
      workflow
  - name: PickFlow Shipping
    description: >-
      Provider-agnostic shipping rates, services, packages, and label purchase
      for PickFlow
  - name: Cycle Counts
    description: >-
      Create, drive, and post PickFlow cycle counts — batches, per-warehouse
      sessions, and CSV import/export
  - name: Print Stations
    description: List paired print stations and enqueue print jobs to them
  - name: Invoices
    description: Get and manage invoices
  - name: Work Orders
    description: >-
      Manage work orders — production lifecycle, steps, materials, links,
      shipments, and comments
  - name: Production Batches
    description: Group and manage work orders as production batches
  - name: Bills
    description: >-
      Accounts payable bill management, payments, attachments, allocations, and
      variance
  - name: Prepayments
    description: Manage vendor prepayments and applications
  - name: Vendor Credits
    description: Manage vendor credits and applications
  - name: Vendor Returns
    description: Manage vendor returns and credit generation
  - name: Customer Returns
    description: Manage customer returns (sales returns), receiving, and restock behavior
  - name: Stock Snapshot
    description: Point-in-time stock snapshots with export support
  - name: Consumption
    description: Consumption reports and exports
  - name: Inventory Aging
    description: Cost-layer-based inventory aging reports
  - name: Bills Reports
    description: Accounts payable bills aging reports
  - name: Forecast
    description: Materialized forecast data
  - name: Reports
    description: Close the books, inventory discrepancy, transaction COGS, and EDI reports
  - name: Tags
    description: Add/remove tags across various resources
  - name: Custom Fields
    description: Get and set custom fields across various resources
  - name: Currency
    description: Currency configuration, exchange rates, and conversion
  - name: Integration Mappings
    description: Manage integration mappings for external systems
  - name: Integration Field Mappings
    description: Manage field-level mappings between Luminous and external systems
paths:
  /activity-logs/ask-ai:
    post:
      tags:
        - Activity Logs
      summary: Ask an AI about a record's history
      description: >
        Sends the complete (unpaginated) activity history for a sales order,

        fulfillment order, or shipment to an LLM along with a free-text
        question,

        and returns the model's answer.


        Useful for summarising what has happened to a record, diagnosing why an

        order behaved a certain way, or generating narrative explanations from

        raw audit-trail entries without having to paginate and parse them
        yourself.


        The endpoint loads the full history server-side, so it does not respect

        the `page` / `limit` filters of the list endpoint — every entry for the

        subject is included in the prompt.
      operationId: askAIAboutActivityLog
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - subjectType
                - subjectId
                - question
              properties:
                subjectType:
                  type: string
                  enum:
                    - sales_order
                    - fulfillment_order
                    - shipment
                  description: Type of subject record
                subjectId:
                  type: integer
                  minimum: 1
                  description: ID of the subject record
                question:
                  type: string
                  maxLength: 1000
                  description: Free-text question to ask about the record's history
            example:
              subjectType: sales_order
              subjectId: 12345
              question: Why did this order spend two days in purgatory before posting?
      responses:
        '200':
          description: AI-generated answer
          content:
            application/json:
              schema:
                type: object
                properties:
                  answer:
                    type: string
                    description: >-
                      Natural-language answer derived from the record's activity
                      log
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
      security:
        - BearerAuth: []
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Authenticate using a bearer token. To create a token, navigate to
        /settings/api-tokens and click Create API Token.

````