---
title: "[Beta] Document Summary"
method: GET
path: "/public/beta/documents/{document_id}/summary"
tags: ["Documents"]
---

# [Beta] Document Summary

`GET /public/beta/documents/{document_id}/summary`

Returns a summary for the specified document. Use query parameter `type` to select summary granularity.

## Path parameters

- `document_id` string, required

## Query parameters

- `type` 'detailed' | 'short' | 'headline' | 'xshort', required — Document summary granularity (query parameter `type`).

## Response `200`

Document Summary is available. JSON object with `type` and `summary` (see schema). Includes `ETag` and `Vary: type` headers.

- DocumentSummaryResponse — Summary response envelope. The `type` field echoes the `type` query parameter.
  - `type` 'detailed' | 'short' | 'headline' | 'xshort', required — Document summary granularity (query parameter `type`).
  - `summary` string, required — Summary text for the requested summary type.

## Other responses

- `202` — The summary is not available yet. Retry after the indicated number of seconds. No response body is returned.
- `400` — The request is invalid. Either the `type` query parameter is missing, or its value is not one of the allowed values (detailed, short, headline, xshort).
- `401` — Authentication error
- `403` — Permission error
- `404` — The document was not found. The document_id does not correspond to any document in the system.
- `429` — Too many requests error

---

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