---
title: "Record summary"
url: https://docs.gleap.ai/en/reference/rest-api/summary
method: GET
path: "/records/{recordType}/{recordId}/summary"
api: "API Reference"
tag: "Records"
operationId: "Summary"
updatedAt: "2026-11-01T18:40:15.677Z"
language: en
---

# Record summary

`GET https://api.gleap.io/v3/records/{recordType}/{recordId}/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.

## Authorization

- `Authorization` (header, required): `Bearer <token>`

## Path parameters

- `recordType` (string, required)
- `recordId` (string, required)

## Headers

- `project` (string, required)

## Example request

```bash
curl --request GET \
  --url 'https://api.gleap.io/v3/records/{recordType}/{recordId}/summary' \
  --header 'Authorization: Bearer <token>' \
  --header 'project: <project>'
```

## Responses

### 200 (`application/json`)

Ok

- `status` (enum<string>, required): One of: `disabled`, `not-enabled`, `not-enough-data`, `ok`, `not-found`, `rate-limited`.
- `summary` (any)
- `stale` (boolean): True when the record has moved on but the cooldown is still holding.

```json
{
  "status": "disabled",
  "stale": true
}
```