summary returns a short summary of the page, written from its text.
Make a request
Get an API key in the Quickstart. This request summarizes a documentation page.Read the response
data.summary is a string. costUsd is the price of the page and the summary together.
Options
onlyMainContent, onlyCleanContent, includeTags and excludeTags decide which text is summarized. See Content filtering. With redactPII, the summary is made from the redacted text. See Safety.
Limits and errors
- The summary is made from the first 50,000 characters of the page’s Markdown. A longer page is summarized from its start.
- When no summary can be made, the call returns
503 sourceUnavailableand costs nothing. Try again after a few seconds. - A PDF can be summarized.
Price
$4 per 1,000 pages: $1 for the page and $3 for the summary. If you ask formarkdown too, it adds nothing.
Related
- Highlights returns the passages that match a query instead of a summary.
- Question answers one question about the page.
- JSON fills the fields you describe.
- Markdown returns the full text.