Documents

[Beta] Document Summary

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

get/public/beta/documents/{document_id}/summary

Path parameters

document_idstring required

The unique identifier of the document.

Query parameters

type'detailed' | 'short' | 'headline' | 'xshort' required

Document summary granularity (query parameter type).

Document summary granularity to return.

Response

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

type'detailed' | 'short' | 'headline' | 'xshort' required

Document summary granularity (query parameter type).

summarystring required

Summary text for the requested summary type.

Changes

No recorded changes to this endpoint across all 1 revision of this API.