Skip to main content
POST

Request Parameters

Body

string
The text content to summarize. Maximum 300,000 characters. Not required if url or file_store_key is specified.
string
URL of a PDF document to summarize. Not required if text or file_store_key is provided.
string
The key of a stored PDF document to summarize from Jigsawstack File Storage. Not required if text or url is provided.
string
default:"text"
The format of the summary: - text: Returns a continuous paragraph summary - points: Returns bullet points as an array of strings
number
default:"2"
The maximum number of bullet points to generate when type is set to points. Maximum value is 100.
number
The maximum number of characters in the generated summary.
string
required
Your JigsawStack API key

Response Structure

The response structure varies based on the type parameter:
boolean
Indicates whether the call was successful.
object
Usage information for the API call.
string
A unique identifier for the request

When type is “text” (default)

string
The generated summary as a continuous paragraph.

When type is “points”

string[]
An array of strings, where each string represents a bullet point in the summary.