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

# Record summary

> The written brief for a record. Never precomputed: this route is the only
thing that ever generates one, so a record nobody opens costs nothing.
Returns `status` — `disabled` (feature off), `not-enough-data`, or `ok` with
the summary, optionally flagged `stale` when the cooldown is holding a
summary the record has since moved past.



## OpenAPI

````yaml https://api.gleap.io/api-docs.json get /records/{recordType}/{recordId}/summary
openapi: 3.0.0
info:
  title: gleap-server
  version: 14.0.0
  contact: {}
servers:
  - url: https://api.gleap.io/v3
security: []
paths:
  /records/{recordType}/{recordId}/summary:
    get:
      tags:
        - Records
      summary: Record summary
      description: >-
        The written brief for a record. Never precomputed: this route is the
        only

        thing that ever generates one, so a record nobody opens costs nothing.

        Returns `status` — `disabled` (feature off), `not-enough-data`, or `ok`
        with

        the summary, optionally flagged `stale` when the cooldown is holding a

        summary the record has since moved past.
      operationId: Summary
      parameters:
        - in: path
          name: recordType
          required: true
          schema:
            type: string
        - in: path
          name: recordId
          required: true
          schema:
            type: string
        - in: header
          name: project
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SummaryResult'
      security:
        - jwt: []
components:
  schemas:
    SummaryResult:
      properties:
        status:
          $ref: '#/components/schemas/SummaryStatus'
        summary: {}
        stale:
          type: boolean
          description: True when the record has moved on but the cooldown is still holding.
      required:
        - status
      type: object
      additionalProperties: false
    SummaryStatus:
      type: string
      enum:
        - disabled
        - not-enabled
        - not-enough-data
        - ok
        - not-found
        - rate-limited
  securitySchemes:
    jwt:
      type: http
      scheme: bearer
      bearerFormat: JWT

````