---
title: "Patch Report Summary"
method: PATCH
path: "/Ai/ReportSummary"
tags: ["Ai"]
---

# Patch Report Summary

`PATCH /Ai/ReportSummary`

**Requires permission:** *AllStaff*

Patches an AI-generated report summary.

## Query parameters

- `page` integer, required
- `pageSize` integer, required
- `includes` string[], nullable
- `sort` string, nullable
- `filter` string, nullable

## Request body

- PatchReportSummaryRequest
  - `summary` Summary
    - `id` integer, nullable
    - `reportId` integer, nullable
    - `term` string, nullable
    - `academicYear` integer, nullable
    - `studentNameId` integer, nullable
    - `studentUpi` string, guid, nullable
    - `generated` string, date-time, nullable
    - `text` string, nullable
    - `summaryType` 0 | 1 | 2
    - `promptTokens` integer, nullable
    - `completionTokens` integer, nullable
    - `outdated` boolean
    - `totalTokens` integer, nullable

## Response `200`

Success - Success

- PatchReportSummaryResponse
  - `summary` Summary
    - `id` integer, nullable
    - `reportId` integer, nullable
    - `term` string, nullable
    - `academicYear` integer, nullable
    - `studentNameId` integer, nullable
    - `studentUpi` string, guid, nullable
    - `generated` string, date-time, nullable
    - `text` string, nullable
    - `summaryType` 0 | 1 | 2
    - `promptTokens` integer, nullable
    - `completionTokens` integer, nullable
    - `outdated` boolean
    - `totalTokens` integer, nullable
  - `meta` Meta
    - `page` integer
    - `pageSize` integer
    - `total` integer

## Other responses

- `400` — An Error Occurred - Explain Error
- `401` — Unauthorized
- `403` — Forbidden

---

[API](https://skmtc.net/tonbridge/apis/tonbridge-app-api.md) · [All operations](https://skmtc.net/tonbridge/apis/tonbridge-app-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tonbridge/tonbridge-app-api/versions/fab57bf5558a/schema)